Skip to content

CLI Reference ​

The CiteKit CLI is the primary management tool for local-first multimodal workflows. It allows you to build maps, resolve evidence, and serve resources to AI agents without writing code.

Quick Reference ​

CommandUsageResponsibilitylink
ingestpython -m citekit.cli ingest <file> or citekit ingest <file>Analyzing files and building semantic maps.Ingest API
resolvepython -m citekit.cli resolve <node> or citekit resolve <node>Extracting clips and slices from sources.Resolve API
inspectpython -m citekit.cli inspect <node> or citekit inspect <node>Viewing technical metadata for a pinpoint.Resolve API
listpython -m citekit.cli list or citekit listExploring the local index of resources.Management API
check-mappython -m citekit.cli check-map <path> or citekit check-map <path>Validating external or edited maps.Management API
structurepython -m citekit.cli structure <id> or citekit structure <id>Dumping a raw map JSON.Management API
adaptpython -m citekit.cli adapt <data>Converting external datasets (GraphRAG, etc).Adapter API
servepython -m citekit.cli serve or citekit serveStarting the Model Context Protocol server.MCP Protocol

Installation ​

The CLI is included automatically with both the Python and JavaScript SDKs. Use Python CLI for adapters (adapt).

Python ​

bash
pip install citekit
python -m citekit.cli --help

JavaScript ​

bash
npm install -g citekit
citekit --help

JavaScript CLI covers core lifecycle commands; adapter conversion is currently Python CLI only. If you prefer not to install globally, use npx citekit instead.


Global Options ​

The following flags apply to most interactive commands:

FlagShorthandDescription
--help-hDisplay help for the command.

Released under the MIT License.