ctxindex source
Configure, inspect, and remove Sources within Realms.
A Source is one configured connection through exactly one Source Adapter. It belongs to one Realm and has a globally unique local label.
Usage
ctxindex source add [options] <adapter-id>
ctxindex source list [--realm <realm>] [--format <format>] [--json]
ctxindex source remove <source>Core add flags
| Flag | Purpose |
|---|---|
--adapter <adapter> | Supply the Adapter ID instead of the positional argument. |
--realm <realm> | Select the required Realm slug. |
--label <label> | Set the globally unique Source label. |
--account <account> | Bind an exact Account label or Account ID. Private Grant IDs are not selectors. |
--config-json <json> | Pass Adapter configuration as JSON. |
--search-routing <mode> | Override routing with indexed, federated, or hybrid. |
--no-sync | Disable synchronization for this Source. |
Source labels default to <account-label>-<adapter-tail>, or <adapter-tail> when no Account is needed. Labels stay verbatim; collisions do not prompt or auto-suffix.
Registry-generated add flags
The currently loaded Adapters expose these generated options:
| Flag | Adapter configuration |
|---|---|
--config-calendar-id <id> | Google or Microsoft calendar ID; defaults to primary or default respectively. |
--config-exclude <glob> | local.directory exclusion glob. |
--config-future-days <days> | Google or Microsoft calendar future window; default 730. |
--config-include <glob> | local.directory inclusion glob. |
--config-past-days <days> | Google or Microsoft calendar past window; default 365. |
--config-root-path <path> | Required absolute root for local.directory. |
--config-size-cap-bytes <bytes> | Maximum local.directory file size. |
Run ctxindex describe adapter <adapter-id> before adding a Source. Loaded Extensions can change this registry-derived flag set.
List flags
| Flag | Purpose |
|---|---|
--realm <realm> | Restrict the list to one Realm slug. |
--format table | Print table output. |
--format compact | Print compact output. |
--json | Print JSON. |
source remove accepts an exact Source label or ID and has no command-specific flags.
JSON output
Only source list accepts --json. source add and source remove print readable results.
Stable exit codes
Exit codes are API: 0 success; 2 invalid usage, an unknown entity, or a label collision; 10 needs_auth; 20 rate limited; 30 network/provider; 40 permission denied; 50 other sync failure; 130 cancelled by SIGINT.