Index commands
Index commands
Reference for indexed index *. For global options (before COMMAND) and for init, docs, and license at the top level, see Other commands (and the sections below that). For walkthroughs, see Create, inspect, update & remove.
Subcommands such as indexed index create files and indexed index create jira also expose Logging and Storage option groups (after the subcommand) — in addition to any global options you pass between indexed and index. Run indexed index create files --help to see the exact groups.
indexed index create
Create a new collection from a connector. Available connectors: files, jira, and confluence (indexed index create --help).
indexed index create files
indexed index create files [OPTIONS]| Option | Default | Description |
|---|---|---|
--collection / -c | files | Collection name |
--path / -p | — | Root path or file(s); from config or prompt if omitted |
--include | — | Regex patterns to include (repeatable) |
--exclude | — | Regex patterns to exclude (repeatable) |
--fail-fast / --no-fail-fast | no-fail-fast | Stop on the first file read error |
--use-cache / --no-cache | use-cache | On-disk parse cache for faster reindexing |
--force | off | Remove an existing collection with the same name first |
--respect-gitignore / --no-respect-gitignore | respect-gitignore | Honor .gitignore and common noise directories |
--local (Storage) | off | Store the collection under ./.indexed/ instead of ~/.indexed/ |
| Logging | --verbose / -v, --log-level, --json-logs (see indexed index create files --help) |
Example:
indexed index create files -c my-docs -p ./docs --include ".*\.md$" --forceindexed index create jira
indexed index create jira [OPTIONS]| Option | Default | Description |
|---|---|---|
--collection / -c | jira | Collection name |
--url / -u | — | Jira base URL; from config or prompt if omitted |
--jql / --query / -q | — | JQL filter; from config or prompt if omitted |
--email | — | Atlassian account email (overrides config / env) |
--token | — | API token (overrides env, e.g. ATLASSIAN_TOKEN) |
--use-cache / --no-cache | use-cache | On-disk cache for unchanged issues |
--force | off | Remove an existing collection with the same name first |
| Logging / Storage | As on create files (--local, --verbose, etc.) |
Long-running credentials and env vars are covered in Config commands and the Jira guide.
Example:
indexed index create jira -c eng-tickets \
-u https://company.atlassian.net \
-q "project = ENG AND created >= -90d"indexed index create confluence
indexed index create confluence [OPTIONS]| Option | Default | Description |
|---|---|---|
--collection / -c | confluence | Collection name |
--url / -u | — | Confluence base URL; from config or prompt if omitted |
--cql / --query / -q | — | CQL filter; from config or prompt if omitted |
--email | — | Atlassian account email (overrides config / env) |
--token | — | API token (overrides env, e.g. ATLASSIAN_TOKEN) |
--read-all-comments / --first-level-comments | read-all-comments | All nested comments vs top level only |
--use-cache / --no-cache | use-cache | On-disk cache for unchanged pages |
--force | off | Remove an existing collection with the same name first |
| Logging / Storage | As on create files (--local, --verbose, etc.) |
Example:
indexed index create confluence -c team-wiki \
-u https://company.atlassian.net/wiki \
-q "space = ENG AND type = page"indexed index search
indexed index search [OPTIONS] QUERYQUERY is a required argument (natural language). Place global flags like --simple-output before index for machine-readable output.
| Option | Default | Description |
|---|---|---|
--collection / -c | all collections | Limit to one collection by name |
--limit / -l | 5 | Max results per collection |
--compact | off | Compact list instead of cards |
--no-content | off | Hide content previews |
| Logging | --verbose / -v, --log-level, --json-logs |
With indexed --simple-output index search …, JSON includes query, total_collections_searched, total_documents_found, total_chunks_found, and results. Each element of results has rank, relevance_score, collection, document_id, document_url, chunk_number, and text. Treat scores as ordering guidance within one response — see Search Index.
Examples:
indexed index search "authentication methods"
indexed index search "rate limiting" -c eng-tickets -l 10
indexed --simple-output index search "deploy" -l 3indexed index inspect
indexed index inspect [OPTIONS] [NAME]| Argument / option | Description |
|---|---|
NAME | Optional. Omit to list all collections; set to inspect one in detail. |
--verbose / -v | When listing all collections, show more detail. |
Examples:
indexed index inspect
indexed index inspect my-docs
indexed --simple-output index inspectindexed index update
indexed index update [OPTIONS] [COLLECTION]| Argument / option | Description |
|---|---|
COLLECTION | Optional. Omit to update every collection. |
| Logging | --verbose / -v, --log-level, --json-logs |
Examples:
indexed index update eng-tickets
indexed index updateindexed index remove
indexed index remove [OPTIONS] COLLECTION| Option | Default | Description |
|---|---|---|
COLLECTION | — | Required: collection to remove. |
--force / -f | off | Skip confirmation. |
| Logging | --verbose / -v, --log-level, --json-logs |
Examples:
indexed index remove my-docs
indexed index remove my-docs --force