---

title: Reference nav_order: 16 permalink: /reference/

Reference

{: .no_toc }

Lookup tables for paths, environment variables, and defaults. {: .fs-6 .fw-300 }

1. TOC {:toc}

Paths

Existing installs with ~/.config/gitcrawl/config.toml continue to load that config when the new platform config path does not exist. Override the config path with --config <path> or GITCRAWL_CONFIG.

Environment variables

Core

Models

GitHub overrides

gh shim

gitcrawl gh moved to Octopool. Run octopool login, then use octopool gh ....

Configuration defaults

Clustering defaults

TUI defaults

Output formats

Exit codes

• 0 — success
• non-zero — usage error, "not implemented" command, or runtime failure

stderr always carries error messages. stdout is reserved for command output.

File-System Layout

Linux:

~/.config/gitcrawl/
├── config.toml
└── stores/
    └── gitcrawl-store/          # portable-store checkout (optional)
        └── data/
            └── owner__repo.sync.db

~/.local/share/gitcrawl/
├── gitcrawl.db                  # SQLite mirror
├── gitcrawl.db-shm              # SQLite shared-memory file
├── gitcrawl.db-wal              # SQLite write-ahead log
└── vectors/                     # vector store backing embeddings

~/.cache/gitcrawl/               # local runtime cache

macOS:

~/Library/Application Support/gitcrawl/
├── config.toml
├── gitcrawl.db                  # SQLite mirror
├── gitcrawl.db-shm              # SQLite shared-memory file
├── gitcrawl.db-wal              # SQLite write-ahead log
├── vectors/                     # vector store backing embeddings
├── logs/
└── stores/
    └── gitcrawl-store/          # portable-store checkout (optional)
        └── data/
            └── owner__repo.sync.db

~/Library/Caches/gitcrawl/       # local runtime cache

Older docs showed cache/pr; current Gitcrawl stores PR details in SQLite instead of a cache/pr directory.

See also

• Configuration — narrative version of this reference
• Commands — every command and flag, in one table
• SPEC.md — product contract
• CHANGELOG.md — what shipped recently