io.github.zainudinnooriPublished by GitHub account zainudinnooriv1.0.0Updated Nov 6, 2026
Setup manuals for any GitHub repo: will it run on macOS, Windows or Linux, and the exact steps.
Remote MCP server that turns any GitHub repository into a per-system setup manual and a ready-to-read setup script.
Web executable via Streamable HTTP. Remote servers run from the web runtime once configured in a workspace.
Paste this prompt into Claude Code, Codex, Cursor or another agent — or into SourceWeft chat. The agent reads this server's install guide, shows you its publisher, endpoint and sign-in, and adds it to your client once you agree. Keys never go into a command.
Read https://sourceweft.com/mcp/io.github.zainudinnoori%2Fgitmanual/install.md and connect the MCP server it describes to my client. Before changing any config, show me its publisher, endpoint and sign-in method and wait for my OK. Never put an API key in a command or in a file I would commit; ask me where it should come from.Add this to your client's mcpServers config.
{
"mcpServers": {
"gitmanual": {
"type": "http",
"url": "https://gitmanual.com/mcp"
}
}
}
Found it on GitHub? Get it running.
Paste any GitHub repo and get its setup manual: will it work on your device, what you need, and the exact steps for macOS, Windows or Linux.
Website · Self-hosting · Contributing · How it works
[Setup manual] [MIT license] [Next.js 16] [TypeScript] [Deploy with Vercel]
Swap hub for manual in any GitHub link:
That's it. You get a manual for the repo, written from its own files.
Plenty of people find a great project on GitHub and don't know how to run it. READMEs assume you already know which runtime, package manager, database and system it needs. gitmanual reads the repo for you and turns it into a manual a newcomer can follow.
[The manual for ollama/ollama]
.env settings.setup.sh or setup.ps1 (/owner/repo/setup/mac.sh, linux.sh, windows.ps1). It stops at the first error, skips what's already installed and is safe to run again. It never starts servers or runs commands that still need your own values; it lists those at the end.Maintainers: add a badge to your README so newcomers find the steps. Swap in your owner/repo:
For AI assistants: an MCP server at https://gitmanual.com/mcp, listed in the MCP Registry as io.github.zainudinnoori/gitmanual. Its tools are get_setup_manual and get_setup_script; no login needed.
claude mcp add --transport http gitmanual https://gitmanual.com/mcphttps://gitmanual.com/mcp~/.cursor/mcp.json) and other clients: { "mcpServers": { "gitmanual": { "url": "https://gitmanual.com/mcp" } } }The same facts are available as JSON at /api/v1/manual?repo=owner/repo (&os=, &arch=, &format=md), and /llms.txt describes it all.
Browser extension: a Setup manual button on every GitHub repo, next to Star and Fork. See extension/.
Plus the shelf (/shelf): every repo people have looked up, with search and filters for stars, language and difficulty. Every repo also gets a share image and a 1080×1080 poster.
gitmanual never clones a repo or runs its code.
raw.githubusercontent.com: the README and setup guides, package manifests, version pins, Docker and CI files, and .env examples.Analyses are cached for 12 hours, and every manual is server-rendered, so search engines can read the steps. How it works explains the verdicts and the limits in plain words.
Requires Node.js 20.9+. Or follow gitmanual's own manual, with steps and a setup script for your system.
Open http://localhost:3000 and paste a repo. Without any settings it works out of the box: history is kept in a local SQLite file (data/gitmanual.db), and GitHub allows about 20 new repos an hour. A GitHub token raises that to thousands.
All settings are environment variables, and every one is optional for local use. See .env.example and the self-hosting guide.
The quickest route is Vercel + Turso (both have free tiers): create a Turso database, add the variables above, and deploy. The step-by-step version is in docs/self-hosting.md.
The visual language (an assembly manual: ink outlines, a wrench-orange box, sticker verdicts) is described in DESIGN.md.
These are the known gaps. Help is welcome:
Wrong steps for a repo? That's the most useful bug report there is. Open an issue with the repo link, or improve a rule yourself. See CONTRIBUTING.md. Please follow the Code of Conduct, and report security issues privately (SECURITY.md).
MIT. The repos gitmanual describes keep their own licenses; it only reads their public files.
Source: README.md at commit 5bd2fa2
Get a repo's setup manual
How to install or run a GitHub repository: whether it works on macOS, Windows or Linux (with reasons), ready-made downloads, install commands from the README, the parts it needs, and step-by-step commands to set it up from source. Facts come from the repo's own files, not guesses.
osarchreporequiredGet a repo's setup script
One script that sets the repo up on the given system: bash for macOS and Linux, PowerShell for Windows. It stops at the first error, skips what's already installed and never starts servers. Show it to the user to read before running it.
osrequiredreporequired100% of the applicable checks met
How complete this listing is, computed from the registry entry, the endpoint and public sources. Not a rating of the server and not a statement that it is safe or working today: reachability is a dated check, and no installs or reviews go into the score.
Published by GitHub account fmuecke
Runs risky commands inside a disposable, offline Windows Sandbox guest, isolated from the rest of the host, on Windows only.
Published by GitHub account exzade
A hosted MCP service that lets ChatGPT, Claude and other clients inspect and act on your own Mac, Windows or Linux computer through a paired local client.
github.com/ollama/ollama → gitmanual.com/ollama/ollama[](https://gitmanual.com/ollama/ollama)git clone https://github.com/zainudinnoori/gitmanual.gitcd gitmanualnpm installcp .env.example .env.local # optional: add a GITHUB_TOKEN (recommended)npm run devapp/ Pages and API routes (Next.js App Router) [owner]/[repo]/ The manual, its share image and poster shelf/ finds/ how-it-works/ api/ analyze, guide (Claude), vote, finds, cron/facebooklib/ pipeline.ts cache → GitHub → analysis → save github.ts GitHub API and raw file downloads detect.ts Stack, versions, services and per-OS steps install.ts Release downloads and README install commands readme.ts guides.ts README sections, setup guides, scripts, docs links fit.ts platforms.ts "Will it work on my device?" os.ts Per-OS installers and PowerShell rewrites db.ts Turso / SQLite og.tsx Share images and posters facebook.ts picks.ts Optional Finds (Facebook Page sync)