How it works

Paste a link. Get a manual.

gitmanual reads a repo's setup files and writes the steps for your system. It never runs the code.

  1. Read

    Only the setup files: README, guides, package and Docker files.

  2. Work out

    The stack, versions, databases and settings it needs.

  3. Check

    Whether it fits your system and chip.

  4. Write

    The maintainers' options first, then steps for your OS.

Will it work on my device?

  • Yes. There's a download, an install command or a Docker route for you.

  • Maybe. It needs something extra, like WSL, a TV or an Apple Silicon Mac.

  • No. The project says it doesn't support your system. We quote it.

Good to know

Can I trust the commands?
Every command comes from the repo's own files or a well-known installer like Homebrew, winget or nvm. README commands are shown exactly as written, and scripts that pipe into your shell get a warning. Still, read a command before you run it.
Does gitmanual run the code?
No. It never downloads the whole repo and never runs anything. It reads a handful of files from GitHub, the way you would.
Where can it be wrong?
  • It only knows what the repo says. An out-of-date README means out-of-date steps.
  • Apps inside a subfolder of a big repo are listed, not fully set up.
  • When the real guide lives on the project's website, we link to it rather than guess.
  • A manual can be up to 12 hours old. “Re-read the repo” refreshes it.
Is the AI guide accurate?
It's written by Claude from the same files, and it can make mistakes. Use it when you're stuck, and check it against the README.
What do you store?
Each repo's manual (public GitHub data), how often it's looked up, and “did it work” answers with the system they were for. No accounts, and nothing else about you. Pressing play on a Reel loads Facebook's video player, which follows Facebook's own privacy rules; until then, nothing on the page comes from Facebook.

Found a wrong step?

Tell us the repo and what actually worked. The rules get better one repo at a time.