Indexed
Reference

Config commands

indexed config * commands, configuration keys, and environment overrides.

Config commands

Reference for every indexed config * subcommand (see indexed config --help), configuration keys, and environment overrides. For global indexed options, see Other commands — global options (top-level). For narrative setup and tuning, see the Configuration guide.


indexed config init

Create a workspace .indexed/ directory in the current working directory with config.toml and .env.example.

indexed config init [flags]
FlagTypeRequiredDefaultDescription
--force / -fflagNooffOverwrite existing workspace config files

Logging options (--verbose, --log-level, --json-logs) apply to this command.

Example:

cd ~
indexed config init

This creates ~/.indexed/ when your shell is in your home directory (because .indexed is resolved relative to the cwd). To use a project-local workspace instead, run indexed config init from your repository root — then config lives at <repo>/.indexed/.


indexed config inspect

Display merged configuration (global + workspace + environment).

indexed config inspect [section] [flags]
Argument / flagTypeRequiredDefaultDescription
sectionstringNoOptional: sources, core, logging, mcp, performance
--defaults / -d / --show-defaultsflagNooffShow all values including defaults

Examples:

indexed config inspect
indexed config inspect sources
indexed config inspect --defaults

JSON: use the global --simple-output flag:

indexed --simple-output config inspect

indexed config set

Set a value in the workspace config.toml (dot path under .indexed/ for the workspace you initialized).

indexed config set <key> <value> [flags]
FlagTypeRequiredDefaultDescription
keystringYesConfig key path (e.g., core.v1.indexing.chunk_size)
valuestringYesNew value (auto-coerced)
--dry-runflagNooffPreview the change without saving

Example:

indexed config set core.v1.indexing.chunk_size 1024
indexed config set core.v1.indexing.chunk_size 1024 --dry-run

indexed config update

Update global configuration only — interactively, or replace it entirely from a TOML file. The --file path replaces the global config, not the workspace .indexed/config.toml from config init.

indexed config update [flags]
FlagTypeRequiredDefaultDescription
--file / -fpathNoPath to a TOML file that replaces the global configuration

Examples:

indexed config update
indexed config update --file ./my-global-config.toml

indexed config delete

Remove a key from the workspace configuration (prompts for confirmation unless --force).

indexed config delete <key> [flags]
FlagTypeRequiredDefaultDescription
--force / -fflagNooffSkip confirmation

Example:

indexed config delete core.v1.indexing.chunk_overlap
indexed config delete core.v1.indexing.chunk_overlap --force

indexed config validate

Validate the active configuration against registered validation rules. Prints errors by section and exits with status 1 if validation fails.

indexed config validate

Run this after manually editing workspace or global config.toml (see the Configuration guide) to catch typos before they cause indexing errors.


Configuration Keys

Indexing

KeyTypeDefaultDescription
core.v1.indexing.chunk_sizeint512Maximum number of tokens per chunk
core.v1.indexing.chunk_overlapint50Number of overlapping tokens between consecutive chunks

Embedding

KeyTypeDefaultDescription
core.v1.embedding.model_namestring"all-MiniLM-L6-v2"Sentence Transformers model to use for embeddings

Files connector

Keys below belong in a [sources.files] table in config.toml. With indexed config set, use the full dot path (for example, sources.files.ocr_enabled true).

KeyTypeDefaultDescription
sources.files.pathstring"."Root directory to index (-p / --path overrides for a single index create run)
sources.files.include_patternslist["*"]Glob-style patterns for paths to include (for example *.md, **/*.py)
sources.files.exclude_patternslist(built-in noise paths)Regex patterns matched against full paths; defaults skip common dirs such as .git, node_modules, and .venv (see indexed config inspect --defaults)
sources.files.fail_fastboolfalseStop indexing on the first file read error
sources.files.respect_gitignorebooltrueHonor .gitignore and skip common noise directories
sources.files.change_trackingstring"auto"Change detection: auto, git, content_hash, mtime, or none
sources.files.ocr_enabledboolfalseEnable OCR for scanned PDFs and images
sources.files.table_structurebooltrueExtract table structure from documents
sources.files.code_chunkingbooltrueUse AST-aware chunking for supported code languages
sources.files.max_chunk_tokensint512Maximum tokens per chunk in the parsing module
sources.files.excluded_extensionslist[]Extensions to skip (e.g. [".lock", ".min.js"])

Precedence

Merged configuration follows global + workspace + environment (indexed config inspect --help). From lowest to highest priority:

  1. Built-in defaults
  2. ~/.indexed/config.toml (global), when present
  3. .indexed/config.toml for your workspace (overrides global where set)
  4. Environment variables (INDEXED__… and connector secrets)
  5. CLI flags on the current command

Environment Variable Overrides

Any configuration key can be overridden with an environment variable using the pattern:

INDEXED__<section>__<subsection>__<key>=<value>

Double underscores (__) separate each level of the config hierarchy. Environment variables override values from config files.

Examples:

export INDEXED__core__v1__indexing__chunk_size=1024
export INDEXED__core__v1__indexing__chunk_overlap=100
export INDEXED__core__v1__embedding__model_name="paraphrase-multilingual-MiniLM-L12-v2"

Connector Credentials

Credentials are read from environment variables only — never from config.toml. CLI flags for indexed index create are in Index commands; this section lists the env vars.

VariableUsed byDescription
ATLASSIAN_EMAILJira Cloud, Confluence CloudAtlassian account email
ATLASSIAN_TOKENJira Cloud, Confluence CloudAtlassian API token
JIRA_TOKENJira Server/DCBearer or personal access token
JIRA_LOGINJira Server/DCUsername (with JIRA_PASSWORD)
JIRA_PASSWORDJira Server/DCPassword (with JIRA_LOGIN)
CONF_TOKENConfluence Server/DCBearer or personal access token
CONF_LOGINConfluence Server/DCUsername (with CONF_PASSWORD)
CONF_PASSWORDConfluence Server/DCPassword (with CONF_LOGIN)

See Jira and Confluence for setup, Cloud vs Server/DC, and troubleshooting.

Keep secrets out of version control

Use .indexed/.env (or your shell) for secrets — not config.toml. Add .env to .gitignore if you keep one in a repo directory.


Example Config File

~/.indexed/config.toml
[core.v1.indexing]
chunk_size = 512
chunk_overlap = 50

[core.v1.embedding]
model_name = "all-MiniLM-L6-v2"

[sources.files]
path = "./documents"
include_patterns = ["*.md", "*.pdf"]
exclude_patterns = ["\\.draft\\.md$", "/build/"]
respect_gitignore = true
change_tracking = "auto"
ocr_enabled = false

Data directory

Indexed stores data under ~/.indexed/:

~/.indexed/
├── config.toml
└── data/
    └── collections/<name>/
        ├── manifest.json
        ├── documents.json
        ├── chunks.json
        └── index.faiss

See What is Indexed for how local data is used.