jarvis-index

PROJECT TOPICS

项目标签

ai-agents ai-tools claude-code code-intelligence code-navigation code-search codebase-analysis codex cursor developer-tools dsh-plugin llm-tools local-first mcp mcp-server model-context-protocol scip skills static-analysis zoekt

INSTALL REFERENCE

安装参考

未验证

dsh plugin --profile web add github:jarvis-intelligence/jarvis-index

在 DSH 中安装

该命令指向仓库当前默认分支；尚无绑定当前 commit 的完整验证结果。

PROJECT README

README

Local-first code intelligence for coding agents. Index your own repositories with SCIP and Zoekt, then let the agent ask structural questions — who calls this?, where is this defined? — instead of guessing from grep.

Everything runs on your machine. No code leaves it, no telemetry, no account.

This repo is the public distribution surface: the Homebrew tap and formula, the optional language-tooling installer, the plugins, the binary release assets, and the issue tracker. It holds no source — see Why this repo exists.

What you get

Ten MCP tools, exposed to any MCP client:

	Tool	Answers
Navigate	`goToDefinition`	Where is `X` defined?
	`findReferences`	Everywhere `X` is used
	`callHierarchy`	What calls `X`, and what `X` calls
	`typeHierarchy`	Super/subtypes of `X`
	`documentSymbols`	Every symbol in a file
Search	`searchCode`	Lexical search across indexed repos (Zoekt)
	`semanticSearch`	Registered for compatibility; unavailable in the Homebrew distribution
Scope	`blastRadius`	Which other indexed repos depend on this package
	`indexRepo`	Builds an index for a local git repo and returns immediately for polling
	`getIndexStatus`	Is this repo indexed, and is the index stale?

Plus three agent skills that ship with the plugin: jarvis-setup (onboarding), jarvis-use (steers the agent toward structural queries over grep), and jarvis-issues (files well-formed bug reports).

Full signatures and return shapes: plugin/skills/jarvis-use/references/tool-roster.md.

Quick start

# 1. Install the standalone binary and MCP server
brew install jarvis-intelligence/jarvis/jarvis

# 2. Verify
jarvis --version                    # expect: jarvis 0.11.0

# 3. Index a repo (slug defaults to the directory name)
jarvis index /path/to/your/repo

# 4. Verify
jarvis status <slug>                # expect: indexed

Then install the plugin below to register jarvis-server and install the agent skills.

Install as a plugin

The plugin bundles the MCP registration and all three skills, so there is no manual mcp add.

Client	How
Claude Code	`/plugin marketplace add jarvis-intelligence/jarvis-index` `/plugin install jarvis@jarvis`
Codex CLI	`codex plugin marketplace add https://github.com/jarvis-intelligence/jarvis-index --ref main` `codex plugin add jarvis`
Cursor	Dashboard → Plugins → Add Marketplace → Import from Repo (Teams/Enterprise) or clone and `ln -s "$PWD/jarvis-index/plugin" ~/.cursor/plugins/local/jarvis`
Other MCP clients	Point them at the stdio command `jarvis-server`

The plugin launches the Homebrew-installed jarvis-server. If needed, install optional language-specific SCIP tooling afterward with the setup skill's --only commands.

Details, Homebrew limits, and privacy notes: plugin/README.md.

Requirements

macOS or Linux with Homebrew/Linuxbrew. Windows is not supported.
jarvis 0.11.0 installed by brew install jarvis-intelligence/jarvis/jarvis.
java on PATH only if you index Java/Kotlin repos.

Language support

One language per index — a polyglot repo indexes only its plurality language.

Language	Indexer	Notes
TypeScript / JavaScript	`scip-typescript`
Python	`scip-python`
Swift	`scip-swift`	macOS arm64 only; pass `--scheme` if the Xcode project has several
Java / Kotlin	`scip-java`	Android/Gradle projects and repos off the pinned Kotlin version are published search-only — lexical search works, SCIP navigation does not, and `semanticSearch` is unavailable in the Homebrew distribution

Why this repo exists

jarvis's development repo is private, and GitHub serves raw files and release assets only to viewers of the owning repo. An unauthenticated curl against a private repo's setup.sh 404s — which is every real user. So every user-facing install path lives here, in public:

optional language-tooling installer, fetchable by anyone
the Homebrew tap and formula
the Claude Code / Codex / Cursor plugins
the scip and zoekt binaries, as GitHub release assets
the issue tracker

Repo layout

setup.sh              optional language-tooling installer — SYNCED from the dev repo, do not edit here
plugin/               The plugin: skills, MCP config, assets — source of truth, edit directly
.claude-plugin/       Claude Code marketplace manifest
.codex-plugin/        Codex CLI plugin manifest
.cursor-plugin/       Cursor marketplace manifest
docs/                 Maintainer documentation for this repo

Editing this repo

Path	Rule
`setup.sh`	Never edit here. The optional language-tooling installer is published automatically from the development repo and overwritten on the next release. Fix it upstream.
everything else	Source of truth is here — edit directly.

Any change under plugin/ must bump the version in all three plugin manifests, to the same value, or it reaches nobody: plugin/.claude-plugin/plugin.json, plugin/.cursor-plugin/plugin.json, .codex-plugin/plugin.json. Plugin 0.11.1 versions independently of the Homebrew jarvis CLI.

Full conventions: docs/code-standards.md.

Docs

overview · architecture · codebase summary · standards · publishing · roadmap

Links

Issues / feature requests: https://github.com/jarvis-intelligence/jarvis-index/issues
Changelog: https://github.com/jarvis-intelligence/jarvis-index/releases/tag/v0.11.1
License: MIT

CLASSIFICATION EVIDENCE

分类依据

项目类型技能

功能分类开发工具

规则置信度高

系统优先读取 GitHub Topics，再与站内分类词典和词根规则比对。当前命中： skills、claude-code、code-intelligence、code-navigation、code-search、developer-tools、mcp、mcp-server、model-context-protocol、static-analysis。