Skip to content

Configuration

aiDimag keeps repo settings in .aidimag/config.json. This file is safe to commit — it never contains secrets (tokens live in ~/.aidimag/credentials.json instead). Committing it means teammates inherit the same settings.

Where settings live

LocationContentsCommitted?
.aidimag/config.jsonRepo settings (sync server, tickets, context, checks)✅ yes (no secrets)
.aidimag/memory.dbThe memory store❌ gitignored
~/.aidimag/credentials.jsonAuth tokens❌ never in the repo

Example config.json

json
{
  "generateContext": {
    "auto": true,
    "format": "all"
  },
  "preCommitCheck": "warn",
  "cloud": {
    "server": "http://your-server:8787",
    "brain": "myrepo"
  },
  "tickets": {
    "provider": "github",
    "branch": { "pattern": "^(feature|fix)/[A-Z]+-\\d+", "enforce": "warn" }
  },
  "knowledge": {
    "folder": "knowledge",
    "summarizer": "auto",
    "requireReview": true,
    "backup": true
  }
}

Options

generateContext

Controls generated context files.

FieldValuesMeaning
autotrue / falseRegenerate context files automatically after verify/review/sync
formatclaude / cursorrules / copilot / allWhich file(s) to write

The easiest way to set this is dim generate-context --auto.

preCommitCheck

Controls the optional pre-commit hook.

ValueBehavior
(unset) / falseHook is a no-op
"warn" / truePrint violations, allow the commit
"block"Print violations and block the commit on a hard violation

cloud

Set by dim cloud link. The server URL and brain name for team sync. No token here — that's in your credentials file.

tickets

Set by dim ticket connect. The connected provider and the branch-naming convention. See Connecting tickets.

knowledge

Controls the knowledge inbox. All fields are optional — defaults work out of the box.

FieldDefaultMeaning
folder"knowledge"Inbox folder (repo-relative) where you drop docs
summarizer"auto"auto (agent → LLM) / agent / llm / off
requireReviewtrueRequire dim review approval before pinning. false auto-approves claims as ACTIVE but unpinned memories (no human reviewed them, so they stay subject to decay and evidence checks — pin keepers with dim pin)
backuptrueKeep originals in .aidimag/knowledge/processed/
extensionstext formats + .pdf/.docxAllowlist of file extensions to summarize (e.g. [".md", ".txt", ".pdf"]). PDF and DOCX text is extracted before summarization
maxBytes1048576Hard size cap; larger files are skipped
chunkBytes16384Soft threshold; larger text docs are chunked before summarizing

Environment variables

Some behavior is controlled by environment variables rather than the config file — see the table in the CLI reference. The most useful:

  • AIDIMAG_REPO — point the CLI/MCP server at a specific repo.
  • AIDIMAG_EMBEDDINGSauto / openai / ollama / off.
  • AIDIMAG_AUTO_SYNC=off — disable automatic sync after writes.

Licensed under Elastic License 2.0 — free for teams of 10 or fewer users.