Install GitHits in one command
npx -y githits@latest init The setup wizard detects supported coding agents, lets you choose what to configure, and can install guidance that tells them when to use GitHits. You review every change before it is applied.
-
Detect your coding agents
GitHits finds supported coding agents installed on your machine. It does not install or configure anything yet.
-
Choose agents and scope
Select which agents to configure, whether setup applies to the current project or your user account, and whether to install GitHits guidance.
-
Sign in to GitHits
The wizard opens GitHub authentication in your browser. GitHits does not request access to your private repositories.
-
Review and apply
Review the proposed changes. Once confirmed, the wizard writes the GitHits MCP configuration and optional guidance for the agents you selected.
-
Verify the setup
The wizard checks the configuration and reports what changed. Run the same command again whenever you want to add an agent or refresh the guidance.
Already using GitHits?
npx -y githits@latest init again to add an agent or refresh the guidance. The wizard shows you the changes before applying them and only updates GitHits MCP and guidance entries.The installer detects the coding agents you already use
Optional agent guidance
If you select this option, the wizard installs guidance alongside the MCP configuration so supported agents know when and how to use GitHits.
-
When to use GitHits
Agents are guided to use GitHits when a task needs context from open-source code, documentation, or package data.
-
Source and documentation
Guidance points agents to code navigation and documentation tools for a specific repository, ref, package, or version.
-
Package inspection
Agents know when to inspect package metadata, dependencies, vulnerabilities, changelogs, and upgrades.
-
Prior art
Agents can search open-source projects for source-linked implementation examples.
What stays untouched
-
Your source code
The installer does not read, upload, or modify your source code.
-
Your private repositories
GitHits does not request access to your private GitHub repositories.
-
Unrelated agent configuration
The installer configures only agents you select and does not overwrite unrelated settings.
Review before running
The GitHits installer is open source. Inspect its source, review the published npm package, or follow the manual setup guide before you run it.
-
View the source
Read the installer source on GitHub.
View on GitHub -
View the package
Inspect the published npm package.
View on npm -
Read the documentation
Review the installation and configuration guides.
Read the docs
Manual installation
Why use npx?
npx downloads and runs the package without a permanent global installation. The -y flag accepts npm's package execution prompt. The GitHits wizard still shows its configuration changes before applying them.After setup
Once setup is complete, your coding agent can use GitHits to:
-
Search indexed code and symbols
Learn more -
Read open-source code without cloning repositories
Learn more -
Search package documentation
Learn more -
Inspect package metadata and dependency graphs
Learn more -
Check known vulnerabilities
Learn more -
Review release notes and package changes
Learn more -
Find prior art with code examples
Learn more
Get started
Install GitHits in one command
Install GitHits or refresh an existing setup with the same command.
npx -y githits@latest init