12 KiB
GNO CLI Reference
Complete command reference for GNO.
Global Flags
All commands accept:
| Flag | Description |
|---|---|
--index <name> |
Use alternate index (default: "default") |
--config <path> |
Override config file path |
--no-color |
Disable colored output |
--verbose |
Enable verbose logging |
--yes |
Non-interactive mode |
--json |
JSON output (where supported) |
--no-pager |
Disable automatic paging |
--offline |
Use cached models only |
Initialization
gno init
gno init [<path>] [options]
| Option | Description |
|---|---|
--name <name> |
Collection name |
--pattern <glob> |
File pattern (default: **/*) |
--include <exts> |
Extension allowlist (e.g., .md,.pdf) |
--exclude <paths> |
Exclude patterns (default: .git,node_modules) |
--tokenizer <type> |
FTS tokenizer: unicode61, porter, trigram |
--language <code> |
BCP-47 language hint |
Collections
gno collection add
gno collection add <path> --name <name> [options]
Options same as init.
gno collection list
gno collection list [--json|--md]
gno collection remove
gno collection remove <name>
gno collection rename
gno collection rename <old> <new>
Indexing
gno update
Sync files from disk (no embedding).
gno update [--git-pull]
gno index
Full index (update + embed).
gno index [options]
| Option | Description |
|---|---|
--collection <name> |
Scope to single collection |
--no-embed |
Skip embedding |
--models-pull |
Download models if missing |
--git-pull |
Git pull before indexing |
gno embed
Generate embeddings only.
gno embed [--force] [--model <uri>] [--batch-size <n>] [--dry-run]
Search Commands
gno search
BM25 keyword search.
gno search <query> [options]
| Option | Default | Description |
|---|---|---|
-n |
5 | Max results |
--min-score |
0 | Minimum score (0-1) |
-c, --collection |
all | Filter to collection |
--tags-any |
- | Filter: has ANY tag (comma-sep) |
--tags-all |
- | Filter: has ALL tags (comma-sep) |
--full |
false | Full content (not snippets) |
--line-numbers |
false | Include line numbers |
--lang |
auto | Language filter |
Output formats: --json, --files, --csv, --md, --xml
gno vsearch
Vector semantic search. Same options as search.
gno vsearch <query> [options]
gno query
Hybrid search with expansion and reranking.
gno query <query> [options]
Search modes (pick one):
| Flag | Time | Description |
|---|---|---|
--fast |
~0.7s | Skip expansion and reranking |
| (default) | ~2-3s | Skip expansion, with reranking |
--thorough |
~5-8s | Full pipeline with expansion |
Additional options:
| Option | Description |
|---|---|
--no-expand |
Disable query expansion |
--no-rerank |
Disable reranking |
--explain |
Print retrieval details to stderr |
gno ask
AI-powered Q&A with citations.
gno ask <question> [options]
| Option | Description |
|---|---|
--fast |
Skip expansion and reranking (fastest) |
--thorough |
Enable query expansion (better recall) |
--answer |
Generate grounded answer |
--no-answer |
Retrieval only |
--max-answer-tokens <n> |
Cap answer length |
--show-sources |
Show all sources |
Document Retrieval
gno get
Get single document.
gno get <ref> [--from <line>] [-l <lines>] [--line-numbers] [--source]
Ref formats:
gno://collection/path— Full URIcollection/path— Relative path#docid— Document IDgno://docs/file.md:120— With line number
gno multi-get
Get multiple documents.
gno multi-get <pattern> [--max-bytes <n>] [--line-numbers]
gno ls
List documents.
gno ls [<scope>] [--json|--files|--md]
Context Management
gno context add
gno context add <scope> "<text>"
Scope formats:
/— Globalcollection:— Collection prefixgno://collection/path— Path prefix
gno context list
gno context list [--json|--md]
gno context rm
gno context rm <scope>
gno context check
Validate context configuration.
gno context check [--json]
Note Linking
gno links
List outgoing links from a document.
gno links <ref> [options]
| Option | Description |
|---|---|
--type |
Filter: wiki, markdown, or all |
--resolved |
Only show resolved links |
--broken |
Only show broken links |
--json |
JSON output |
gno backlinks
Find documents linking TO a target.
gno backlinks <ref> [options]
| Option | Description |
|---|---|
-n |
Max results (default: 20) |
--json |
JSON output |
gno similar
Find semantically similar documents.
gno similar <ref> [options]
| Option | Description |
|---|---|
-n |
Max results (default: 5) |
--threshold |
Min similarity (0-1) |
--cross-collection |
Search across all collections |
--json |
JSON output |
Requirements: Embeddings must exist for source and target documents.
gno graph
Generate knowledge graph of document connections.
gno graph [options]
| Option | Default | Description |
|---|---|---|
-c, --collection |
all | Filter to single collection |
--limit |
2000 | Max nodes |
--edge-limit |
10000 | Max edges |
--similar |
false | Include similarity edges |
--threshold |
0.7 | Similarity threshold (0-1) |
--linked-only |
true | Exclude isolated nodes |
--similar-top-k |
5 | Similar docs per node (max 20) |
--json |
- | JSON output |
Edge types: wiki (wiki links), markdown (md links), similar (vector similarity).
Web UI: Access interactive graph at http://localhost:3000/graph via gno serve.
Tags
gno tags
List tags with document counts.
gno tags [options]
| Option | Description |
|---|---|
-c, --collection |
Filter by collection |
--prefix |
Filter by tag prefix |
--json |
JSON output |
--md |
Markdown table output |
gno tags add
Add tag to document.
gno tags add <doc> <tag>
doc: URI (gno://...) or docid (#abc123)tag: Tag string (lowercase, alphanumeric, hyphens, dots,/for hierarchy)
gno tags rm
Remove tag from document.
gno tags rm <doc> <tag>
Models
gno models list
gno models list [--json|--md]
gno models use
gno models use <preset>
Presets: slim (~1GB), balanced (~2GB), quality (~2.5GB)
gno models pull
gno models pull [--all|--embed|--rerank|--gen] [--force]
gno models clear
gno models clear [--all|--embed|--rerank|--gen]
gno models path
gno models path [--json]
Maintenance
gno status
gno status [--json|--md]
gno doctor
gno doctor [--json|--md]
gno cleanup
gno cleanup
gno vec
Vector index maintenance. Use when gno similar returns empty despite embeddings.
gno vec sync # Fast incremental sync
gno vec rebuild # Full rebuild
| Option | Description |
|---|---|
--json |
JSON output |
MCP Server
gno mcp
Start MCP server (stdio transport).
gno mcp
gno mcp install
Install GNO as MCP server in client configurations.
gno mcp install [options]
| Option | Default | Description |
|---|---|---|
-t, --target |
claude-desktop | Target: claude-desktop, claude-code, codex |
-s, --scope |
user | Scope: user, project |
-f, --force |
false | Overwrite existing config |
--dry-run |
false | Preview changes |
Examples:
# Claude Desktop (default)
gno mcp install
# Claude Code (user scope)
gno mcp install -t claude-code
# Claude Code (project scope)
gno mcp install -t claude-code -s project
gno mcp uninstall
Remove GNO MCP server from client configuration.
gno mcp uninstall [-t <target>] [-s <scope>]
gno mcp status
Show MCP installation status.
gno mcp status [--json]
Web UI
gno serve
Start web UI for browsing, searching, and querying documents.
gno serve [options]
| Option | Default | Description |
|---|---|---|
-p, --port |
3000 | Port to serve on |
--host |
0.0.0.0 | Host to bind |
Features: Dashboard, search, browse collections, document viewer, AI Q&A with citations.
Skill Management
gno skill install
Install GNO skill for AI coding assistants.
gno skill install [options]
| Option | Default | Description |
|---|---|---|
-t, --target |
claude | Target: claude, codex, amp |
-s, --scope |
user | Scope: user, project |
-f, --force |
false | Overwrite existing |
--dry-run |
false | Preview changes |
Examples:
gno skill install --target claude --scope project
gno skill install --target codex --scope user
gno skill uninstall
Remove GNO skill from AI assistant.
gno skill uninstall [-t <target>] [-s <scope>]
gno skill show
Preview skill files that would be installed.
gno skill show [--json]
gno skill paths
Show skill installation paths for each target.
gno skill paths [--json]
Additional Admin Commands
gno reset
Delete all GNO data (database, embeddings, config). Use with caution.
gno reset [--force]
gno completion
Install shell tab completion.
gno completion install [--shell <bash|zsh|fish>]
gno completion uninstall
Exit Codes
| Code | Description |
|---|---|
| 0 | Success |
| 1 | Validation error (bad args) |
| 2 | Runtime error (IO, DB, model) |