CLI Overview
The nekosearch executable prepares your documentation catalog and starts its MCP server. Snapshot management and client configuration are explicit commands; serving is local and read-only.
nekosearch --helpCommand families
| Task | Commands |
|---|---|
| Interactive onboarding and client selection | setup |
| Build without installing | build |
| Install documentation | add --dir, add --github, add --from, add nestjs@11, add nestjs@12 |
| Inspect the catalog | list, status |
| Refresh curated documentation | update nestjs@11, update nestjs@12 |
| Remove an installed snapshot | remove |
| Configure or remove Grok Build registration | mcp configure grok-build, mcp remove grok-build |
| Start the MCP stdio process | serve |
There are no CLI search or fetch subcommands. Agents use the MCP tools to retrieve documentation.
Source selectors
Commands address sources using source@version, for example nestjs@12 or my-api@1. Use list to inspect installed selectors. MCP clients discover the selectors loaded into their session with list_docs.
Adding an existing selector fails rather than overwriting it. Only the curated NestJS integration has a public update command. See Updating & Removing for custom replacements.
Network access
| Command | Uses network |
|---|---|
build, list, remove, add --dir, add --from | No |
status | No, unless --check-upstream explicitly requests checks |
serve, mcp configure grok-build, mcp remove grok-build | No NekoSearch documentation download; provider commands delegate to Grok CLI |
setup | Only for selected curated documentation downloads |
add --github, curated add and update | Yes, HTTPS to GitHub |
The server does not expose HTTP or SSE transport. Your MCP client starts a child process and communicates with it over stdin/stdout. Logs go to stderr.
Exit and output behavior
Successful commands generally exit 0. Operational failures exit 1. Unknown command forms and invalid status or GitHub-add arguments exit 2; setup also exits 2 in a non-interactive terminal. Setup cancellation exits 130.
list and status write readable state to stdout. build writes its summary and diagnostics to stderr. serve reserves stdout for MCP protocol traffic. There is no general-purpose CLI --json output option.
Use the Command Reference for accepted command forms, options, and errors.
