Skip to content

Docs: Add Windows (Git Bash) SSH setup & shallow clone instructions + common auth errors #27

@thezestycorp

Description

@thezestycorp

Summary
On Windows (Git Bash), cloning the repo via HTTPS caused repeated auth errors. Switching to SSH keys solved it. Suggest adding a short “Windows (Git Bash) setup” section and a shallow-clone example to the README.

Environment

OS: Windows 11 Home

Shell: Git Bash (MINGW64)

Git: git --version → (paste)

Rust: rustc --version / cargo --version → (paste)

What I tried

HTTPS (failed with 401)

git clone https://github.com//monad.git

Errors seen:

- 401 Unauthorized

- "credential-manager-core is not a git command"

- "Password authentication is not supported for Git operations"

What fixed it (SSH route)
ssh-keygen -t ed25519 -C "my_email@example.com"
eval "$(ssh-agent -s)"
ssh-add ~/.ssh/id_ed25519

Added ~/.ssh/id_ed25519.pub to GitHub → Settings → SSH keys

Then clone with SSH:

git clone git@github.com//monad.git

Optional: shallow clone to keep it light

git clone --depth=1 git@github.com//monad.git

Why this helps

Many Windows users hit the same auth loop in Git Bash.

A short SSH section + a one-line shallow clone keeps the onboarding <2 minutes.

Reduces repeated “401/credential-manager” questions.

Screenshots / logs
(attach the auth error screenshots + final success)

Suggestion
Add a “Windows (Git Bash) Quick Start” block to README:

Windows (Git Bash)

ssh-keygen -t ed25519 -C "your_email@example.com"
eval "$(ssh-agent -s)"
ssh-add ~/.ssh/id_ed25519

Add ~/.ssh/id_ed25519.pub to GitHub → Settings → SSH and GPG keys

git clone --depth=1 git@github.com//monad.git
cd monad
cargo build --release # optional

Image

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions