cartog 0.31.1

Code graph indexer for LLM coding agents. Map your codebase, navigate by graph.
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
mod cli;
mod commands;
mod config;
use cartog::auto_check::{self, CommandKind, MaybeSpawnInput};
use cartog::state;

use anyhow::Result;
use cartog_mcp as mcp;
use clap::Parser;
use std::io::IsTerminal;
use std::path::Path;
use std::time::SystemTime;

use cli::{Cli, Command, RagCommand, SelfCommand};

/// Public-default GitHub latest-release endpoint for the daily background
/// check. Override via `CARTOG_GITHUB_API_URL` (used by integration tests).
const DEFAULT_GITHUB_LATEST_URL: &str =
    "https://api.github.com/repos/jrollin/cartog/releases/latest";

/// If `cmd` is a subcommand that depends on a successfully-parsed
/// `[remote]` (and therefore must not run against a rejected config),
/// return its short verb for the user-facing error message. Returns
/// `None` for every other command. Centralising this here keeps the
/// "list of remote commands" in one place — adding a future
/// `cartog mirror` only requires extending this match.
fn remote_command_label(cmd: &Command) -> Option<&'static str> {
    match cmd {
        Command::Push { .. } => Some("push"),
        Command::Pull { .. } => Some("pull"),
        _ => None,
    }
}

/// Commands that build a code-graph index and therefore consume the
/// `[index]`/`[security]`/`[lsp]` config — used to warn when a rejected config
/// silently drops those settings.
fn indexes_with_config(cmd: &Command) -> bool {
    matches!(
        cmd,
        Command::Index { .. }
            | Command::Watch { .. }
            | Command::Serve { .. }
            | Command::Rag(RagCommand::Index { .. })
    )
}

/// Explicit one-shot index creators gated by the consent rule: with no config
/// and no existing index, these refuse rather than materialize a `.cartog/`.
/// Defined as the `indexes_with_config` set minus `Serve` (which starts
/// degraded instead of refusing) — so a future index command added there is
/// gated automatically, not silently bypassed.
fn is_gated_write_command(cmd: &Command) -> bool {
    indexes_with_config(cmd) && !matches!(cmd, Command::Serve { .. })
}

/// Long-lived commands (`serve`, `watch`) skip the auto-check — they run
/// for hours and the user never sees a hint printed at the *start* anyway.
fn classify_command(cmd: &Command) -> CommandKind {
    match cmd {
        Command::Serve { .. } | Command::Watch { .. } => CommandKind::LongLived,
        _ => CommandKind::Quick,
    }
}

/// Walk up from cwd to a `.git` directory; fall back to cwd. Used by
/// `migrate-db` when the resolved DB path is outside the project.
fn project_root_from_cwd() -> std::path::PathBuf {
    use std::path::PathBuf;
    let cwd = std::env::current_dir().unwrap_or_else(|_| PathBuf::from("."));
    let mut dir = cwd.clone();
    loop {
        if dir.join(".git").exists() {
            return dir;
        }
        if !dir.pop() {
            break;
        }
    }
    cwd
}

fn run_auto_check_epilogue(command_kind: CommandKind) {
    let api_url = std::env::var("CARTOG_GITHUB_API_URL")
        .unwrap_or_else(|_| DEFAULT_GITHUB_LATEST_URL.to_string());
    let state_path = state::default_state_file();
    let disabled_env = std::env::var("CARTOG_NO_UPDATE_CHECK").ok();
    let mode_env = std::env::var("CARTOG_UPDATE_CHECK").ok();
    let stdout_is_tty = std::io::stdout().is_terminal();

    auto_check::maybe_spawn(MaybeSpawnInput {
        command_kind,
        stdout_is_tty,
        disabled_env: disabled_env.as_deref(),
        mode_env: mode_env.as_deref(),
        state_path: state_path.as_deref(),
        api_url: &api_url,
        current_version: env!("CARGO_PKG_VERSION"),
        now: SystemTime::now(),
    });
}

fn main() -> Result<()> {
    let cli = Cli::parse();

    // Resolve database path: --db / CARTOG_DB > .cartog.toml > git root > cwd.
    //
    // `config_load` may be `Rejected` when `.cartog.toml` exists but failed
    // its security pre-check or schema validation. We surface that as a hard
    // error before dispatching push/pull/doctor — silently falling back to
    // defaults would mask the user's security-relevant config error with a
    // downstream "no remote configured" message.
    let config_load = config::load_config();

    // Refuse commands that depend on a successfully-parsed `[remote]`
    // (`push`, `pull`) when the config was rejected. Doctor and config
    // are NOT in this set: they're the commands users run to *diagnose*
    // a broken config, so they need to keep running — they just receive
    // a `config_rejected` signal so they can show an explicit "rejected"
    // status instead of silently reporting defaults.
    if config_load.is_rejected() {
        if let Some(verb) = remote_command_label(&cli.command) {
            anyhow::bail!(
                "refusing to run `cartog {verb}`: configuration file {} was rejected \
                 (see earlier stderr for details). Fix the config before retrying.",
                config_load
                    .path()
                    .expect("Rejected variant always has a path")
                    .display(),
            );
        }
    }

    let config_rejected = config_load.is_rejected();
    // Consent signal #1: a successfully-loaded `.cartog.toml`. A `Rejected`
    // (broken) config is NOT consent — captured here before `config_or_default`
    // collapses the enum to a plain config.
    let config_present = matches!(config_load, config::ConfigLoad::Loaded { .. });
    let config_path = config_load.path().map(|p| p.to_path_buf());
    // A rejected config silently falls back to defaults, so an indexing command
    // would ignore `[index] exclude`, `[security]`, and `[lsp.<lang>]` without
    // saying so. The underlying parse error is already on stderr; add a note
    // that those settings were dropped for commands that actually consume them.
    if config_rejected && indexes_with_config(&cli.command) {
        if let Some(p) = &config_path {
            eprintln!(
                "cartog: note: {} was rejected; indexing with defaults \
                 ([index] exclude, [security], and [lsp] settings ignored).",
                p.display()
            );
        }
    }
    let cartog_config = config_load.config_or_default();

    let db_path = config::resolve_db_path(cli.db.clone(), &cartog_config);
    // Consent gate: may we create a fresh `.cartog/` for this project? True when
    // a config is present, the DB already exists, or `CARTOG_AUTO_INIT` is set.
    // The explicit one-shot creators (`index` / `rag index` / `watch`) refuse
    // up front when this is false; `serve` instead starts degraded (threaded in
    // below), and read commands fall back to an empty in-memory DB (see
    // `commands::shared::open_db`).
    let allow_create = config::allow_index_creation(&db_path, config_present);
    if !allow_create && is_gated_write_command(&cli.command) {
        anyhow::bail!(
            "no .cartog.toml in this project and no existing index — refusing to \
             create one. Run `cartog init` to opt in (then `cartog index .`), or set \
             CARTOG_AUTO_INIT=1 to index with defaults without writing a config file."
        );
    }
    let provider_config = config::to_provider_config(&cartog_config);
    let redact = config::to_redaction_config(&cartog_config);
    // read_config already validated this, so it only re-builds a known-good
    // filter; the `?` keeps any surprise catchable via main's Result.
    let walk_filter = config::to_walk_filter(&cartog_config).map_err(|e| anyhow::anyhow!("{e}"))?;
    let embedding_dim = provider_config.resolved_dimension();
    let search_tuning = cartog_config
        .rag
        .as_ref()
        .map(|r| r.to_search_tuning())
        .unwrap_or_default();
    let lsp_overrides = config::to_lsp_overrides(&cartog_config);

    let is_serve = matches!(cli.command, Command::Serve { .. });
    let is_watch = matches!(cli.command, Command::Watch { .. });
    let is_rag = matches!(
        cli.command,
        Command::Rag(RagCommand::Index { .. }) | Command::Rag(RagCommand::Setup)
    );
    // When stderr is captured (MCP child, piped CI output) info-level tracing
    // looks like errors to the parent. Default to warn in that mode so only
    // real problems surface; foreground TTY users keep info-level progress.
    let stderr_is_tty = std::io::stderr().is_terminal();
    let default_level = if (is_serve || is_rag || is_watch) && stderr_is_tty {
        "info"
    } else {
        "warn"
    };

    // Initialize tracing to stderr via `SpinnerSafeWriter`, which clears the
    // spinner line before each record so info logs and a live spinner coexist
    // without garbling each other (no more level-based suppression). Stdout
    // stays clean for CLI output and MCP protocol.
    tracing_subscriber::fmt()
        .with_writer(commands::SpinnerSafeWriter)
        .with_env_filter(
            tracing_subscriber::EnvFilter::try_from_default_env()
                .unwrap_or_else(|_| tracing_subscriber::EnvFilter::new(default_level)),
        )
        .init();

    // Surface resolved paths once tracing is live so `-v` / RUST_LOG=info users
    // can see which config and DB are actually in effect.
    if let Some(ref p) = config_path {
        tracing::info!(path = %p.display(), "loaded .cartog.toml");
    } else {
        tracing::debug!("no .cartog.toml found; using defaults");
    }
    tracing::debug!(path = %db_path.display(), "resolved database path");

    // Token budget only applies to human-readable output
    let token_budget = if cli.json { None } else { cli.tokens };

    // Field-stripping only applies to JSON output (a no-op for human text).
    let compact = cli.json && cli.compact;

    // Classify before the match consumes cli.command.
    let command_kind = classify_command(&cli.command);

    let result = match cli.command {
        Command::Index {
            path,
            force,
            no_lsp,
            jobs,
        } => {
            // --jobs wins over CARTOG_JOBS / [index] jobs (already in walk_filter).
            let filter = match jobs {
                Some(n) => cartog_indexer::WalkFilter {
                    jobs: n,
                    ..walk_filter.clone()
                },
                None => walk_filter.clone(),
            };
            commands::cmd_index(
                &db_path,
                &path,
                force,
                !no_lsp,
                cli.json,
                embedding_dim,
                redact,
                &lsp_overrides,
                &filter,
            )
        }
        Command::Outline { file } => commands::cmd_outline(
            &db_path,
            &file,
            cli.json,
            compact,
            token_budget,
            embedding_dim,
        ),
        Command::Callees { name } => {
            commands::cmd_callees(&db_path, &name, cli.json, token_budget, embedding_dim)
        }
        Command::Impact { name, depth } => commands::cmd_impact(
            &db_path,
            &name,
            depth,
            cli.json,
            token_budget,
            embedding_dim,
        ),
        Command::Context { task, tokens } => commands::cmd_context(
            &db_path,
            &task,
            tokens,
            cli.json,
            compact,
            &provider_config,
            &search_tuning,
        ),
        Command::Trace { from, to, depth } => commands::cmd_trace(
            &db_path,
            &from,
            &to,
            depth,
            cli.json,
            compact,
            token_budget,
            embedding_dim,
        ),
        Command::Refs { name, kind } => commands::cmd_refs(
            &db_path,
            &name,
            kind,
            cli.json,
            compact,
            token_budget,
            embedding_dim,
        ),
        Command::Hierarchy { name, mermaid } => commands::cmd_hierarchy(
            &db_path,
            &name,
            cli.json,
            mermaid,
            token_budget,
            embedding_dim,
        ),
        Command::Deps { file, mermaid } => commands::cmd_deps(
            &db_path,
            &file,
            cli.json,
            mermaid,
            token_budget,
            embedding_dim,
        ),
        Command::Stats { savings } => {
            commands::cmd_stats(&db_path, cli.json, token_budget, embedding_dim, savings)
        }
        Command::Savings => {
            commands::cmd_stats(&db_path, cli.json, token_budget, embedding_dim, true)
        }
        Command::Push { remote } => {
            commands::cmd_push(&db_path, &cartog_config, remote.as_deref(), cli.json)
        }
        Command::Pull {
            remote,
            force,
            no_sign_request,
        } => commands::cmd_pull(
            &db_path,
            &cartog_config,
            remote.as_deref(),
            force,
            no_sign_request,
            cli.json,
        ),
        Command::Config => commands::cmd_config(
            &cartog_config,
            config_path.as_deref(),
            config_rejected,
            &db_path,
            cli.json,
        ),
        Command::Doctor => commands::cmd_doctor(
            &cartog_config,
            config_path.as_deref(),
            config_rejected,
            &db_path,
            cli.json,
            embedding_dim,
            &provider_config,
        ),
        Command::Search {
            query,
            kind,
            file,
            limit,
        } => commands::cmd_search(
            &db_path,
            &query,
            kind,
            file.as_deref(),
            limit,
            cli.json,
            compact,
            token_budget,
            embedding_dim,
        ),
        Command::Map { tokens, mermaid } => {
            commands::cmd_map(&db_path, tokens, cli.json, compact, mermaid, embedding_dim)
        }
        Command::Changes { commits, kind } => commands::cmd_changes(
            &db_path,
            commits,
            kind,
            cli.json,
            compact,
            token_budget,
            embedding_dim,
        ),
        Command::Watch {
            path,
            debounce,
            rag,
            rag_delay,
        } => commands::cmd_watch(
            &db_path,
            &path,
            debounce,
            config::resolve_auto_embed(rag, &cartog_config),
            rag_delay,
            provider_config,
            redact,
            walk_filter,
            allow_create,
            cli.json,
        ),
        Command::Init { dry_run } => commands::init::cmd_init(dry_run, cli.json),
        Command::Ide {
            client,
            scope,
            yes,
            dry_run,
            no_watch,
        } => commands::ide::cmd_ide(client, scope, yes, dry_run, no_watch, cli.json),
        Command::Install {
            clients,
            scope,
            dry_run,
            no_watch,
        } => commands::ide::cmd_install(clients, scope, dry_run, no_watch, cli.json),
        Command::Serve { watch, rag } => {
            let rag_override = config::resolve_auto_embed(rag, &cartog_config);
            // Auto-embed only runs via the watcher; warn whenever it was requested
            // (flag, [embedding] auto_embed, or CARTOG_WATCH_RAG) without --watch.
            if !watch && rag_override == Some(true) {
                tracing::warn!("auto-embed (--rag / auto_embed / CARTOG_WATCH_RAG) has no effect without --watch");
            }
            let runtime = tokio::runtime::Runtime::new()?;
            // pid_lock_dir/slot must be both-or-neither: a sandboxed host with no
            // resolvable state dir falls back to untracked mode rather than
            // hard-failing on the inverse half-config check in acquire_serve_lock.
            let pid_lock_dir = state::default_state_dir();
            let pid_lock_slot = pid_lock_dir
                .as_ref()
                .map(|_| state::slot_for_db("serve", &db_path));
            let opts = mcp::ServerOptions {
                pid_lock_dir,
                pid_lock_slot,
            };
            runtime.block_on(mcp::run_server(
                &db_path,
                watch,
                rag_override,
                provider_config,
                redact,
                lsp_overrides,
                walk_filter,
                allow_create,
                opts,
            ))
        }
        Command::Rag(rag_cmd) => match rag_cmd {
            RagCommand::Setup => commands::cmd_rag_setup(cli.json, &provider_config),
            RagCommand::Index { path, force } => commands::cmd_rag_index(
                &db_path,
                &path,
                force,
                cli.json,
                &provider_config,
                redact,
                &walk_filter,
            ),
            RagCommand::Search { query, kind, limit } => commands::cmd_rag_search(
                &db_path,
                &query,
                kind,
                limit,
                cli.json,
                compact,
                token_budget,
                &provider_config,
                &search_tuning,
            ),
        },
        Command::Completions { shell } => {
            use clap::CommandFactory;
            let mut cmd = Cli::command();
            clap_complete::generate(shell, &mut cmd, "cartog", &mut std::io::stdout());
            Ok(())
        }
        Command::Manpage => {
            use clap::CommandFactory;
            let cmd = Cli::command();
            clap_mangen::Man::new(cmd)
                .render(&mut std::io::stdout())
                .map_err(Into::into)
        }
        Command::Self_(sub) => match sub {
            SelfCommand::Update {
                check,
                defer,
                to,
                apply_pending,
                at_startup,
                quiet,
            } => commands::cmd_self_update(
                commands::UpdateMode::from_flags(check, defer, to, apply_pending, at_startup),
                &db_path,
                quiet,
                cli.json,
            ),
            SelfCommand::Version => commands::cmd_self_version(cli.json),
            SelfCommand::Rollback => commands::cmd_self_rollback(),
            SelfCommand::MigrateDb { dry_run } => {
                // Explicit --db/CARTOG_DB/[database].path can point outside the project;
                // anchor at the project root in that case, not at the DB parent.
                let explicit_override = cli.db.is_some()
                    || cartog_config
                        .database
                        .as_ref()
                        .is_some_and(|d| d.path.is_some());
                let root = if explicit_override {
                    project_root_from_cwd()
                } else {
                    let parent = db_path
                        .parent()
                        .map(Path::to_path_buf)
                        .unwrap_or_else(|| std::env::current_dir().unwrap_or_else(|_| ".".into()));
                    if parent.file_name().and_then(|n| n.to_str()) == Some(cartog_db::DB_DIR) {
                        parent.parent().map(Path::to_path_buf).unwrap_or(parent)
                    } else {
                        parent
                    }
                };
                commands::cmd_self_migrate_db(&root, dry_run, cli.json)
            }
        },
    };

    run_auto_check_epilogue(command_kind);

    result
}