Repository navigation
Expand file tree
/
Copy pathmain.py
More file actions
3792 lines (3259 loc) · 162 KB
/
Copy pathmain.py
File metadata and controls
3792 lines (3259 loc) · 162 KB
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
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
# src/codegraphcontext/cli/main.py
"""
This module defines the command-line interface (CLI) for the CodeGraphContext application.
It uses the Typer library to create a user-friendly and well-documented CLI.
Commands:
- mcp setup: Runs an interactive wizard to configure the MCP client.
- mcp start: Launches the main MCP server.
- help: Displays help information.
- version: Show the installed version.
"""
import sys
import typer
from rich.console import Console
from rich.table import Table
from rich import box
from typing import Optional
import asyncio
import logging
import json
import os
from pathlib import Path
from importlib.metadata import version as pkg_version, PackageNotFoundError
from codegraphcontext.server import MCPServer
from .setup_wizard import run_neo4j_setup_wizard, configure_mcp_client
from . import config_manager
from . import project_config
# Import the new helper functions
from .cli_helpers import (
index_helper,
add_package_helper,
list_repos_helper,
delete_helper,
cypher_helper,
cypher_helper_visual,
visualize_helper,
reindex_helper,
update_helper,
clean_helper,
stats_helper,
_initialize_services,
watch_helper,
unwatch_helper,
list_watching_helper,
setup_scip_helper,
)
from .hook_manager import HookError, get_hook_status, install_hooks, uninstall_hooks
from codegraphcontext.utils.tool_limits import get_tool_result_limit
# Set the log level for the noisy neo4j, asyncio, and urllib3 loggers to keep the output clean.
# Get the log level from config, defaulting to WARNING
def _configure_library_loggers():
"""Configure third-party library loggers based on config setting."""
try:
log_level_str = config_manager.get_config_value('LIBRARY_LOG_LEVEL')
if log_level_str is None:
log_level_str = 'WARNING'
log_level_str = str(log_level_str).upper()
log_level = getattr(logging, log_level_str, logging.WARNING)
except (AttributeError, Exception):
log_level = logging.WARNING
logging.getLogger("neo4j").setLevel(log_level)
logging.getLogger("asyncio").setLevel(log_level)
logging.getLogger("urllib3").setLevel(log_level)
_configure_library_loggers()
# Import visualization module
from .visualizer import (
visualize_call_graph,
visualize_call_chain,
visualize_dependencies,
visualize_inheritance_tree,
visualize_overrides,
visualize_search_results,
check_visual_flag,
)
# Initialize the Typer app and Rich console for formatted output.
app = typer.Typer(
name="cgc",
help="CodeGraphContext: An MCP server for AI-powered code analysis.",
add_completion=True,
# `-h` is accepted as --help on every command, not just at the root.
context_settings={"help_option_names": ["-h", "--help"]},
)
console = Console(stderr=True)
# `analyze` prints its primary product (the table, and the notice that there is
# none), so it goes to stdout like `cgc stats` / `cgc diagram` already do;
# `console` stays for interactive prompts and diagnostics. Argument validation
# errors inside those commands remain on the stderr console.
analyze_result_console = Console()
find_result_console = Console()
# Configure basic logging for the application. Default to WARNING so CLI
# output stays clean; the root --debug flag switches this to DEBUG.
logging.basicConfig(level=logging.WARNING, format='%(asctime)s - %(levelname)s - %(name)s - %(message)s')
def get_version() -> str:
"""
Try to read version from the installed package metadata.
Fallback to a dev version if not installed.
"""
try:
return pkg_version("codegraphcontext") # must match [project].name in pyproject.toml
except PackageNotFoundError:
return "0.0.0 (dev)"
# Create MCP command group
mcp_app = typer.Typer(help="MCP client configuration commands")
app.add_typer(mcp_app, name="mcp")
@mcp_app.command("setup")
def mcp_setup():
"""
Configure MCP Client (IDE/CLI Integration).
Sets up CodeGraphContext integration with your IDE or CLI tool:
- VS Code, Cursor, Windsurf, Zed
- Claude Desktop, Gemini CLI
- Cline, RooCode, Amazon Q Developer, Goose
- OpenCode (prints stdio config + link to vendor docs)
Works with FalkorDB by default (no database setup needed).
"""
console.print("\n[bold cyan]MCP Client Setup[/bold cyan]")
console.print("Configure your IDE or CLI tool to use CodeGraphContext.\n")
configure_mcp_client()
@mcp_app.command("start")
def mcp_start():
"""
Start the CodeGraphContext MCP server.
Starts the server which listens for JSON-RPC requests from stdin.
This is used by IDE integrations (VS Code, Cursor, Zed, etc.).
"""
console.print("[bold green]Starting CodeGraphContext Server...[/bold green]")
_load_credentials()
server = None
loop = asyncio.new_event_loop()
asyncio.set_event_loop(loop)
try:
server = MCPServer(loop=loop, cwd=Path.cwd())
loop.run_until_complete(server.run())
except ValueError as e:
# This typically happens if credentials are still not found after all checks.
console.print(f"[bold red]Configuration Error:[/bold red] {e}")
console.print("Please run `cgc neo4j setup` or use FalkorDB (default).")
raise typer.Exit(code=1) from e
except KeyboardInterrupt:
# Handle graceful shutdown on Ctrl+C.
console.print("\n[bold yellow]Server stopped by user.[/bold yellow]")
finally:
# Ensure server and event loop are properly closed.
if server:
server.shutdown()
loop.close()
@mcp_app.command("tools")
def mcp_tools():
"""
List all available MCP tools.
Shows all tools that can be called by AI assistants through the MCP interface.
"""
_load_credentials()
console.print("[bold green]Available MCP Tools:[/bold green]")
try:
# Instantiate the server to access the tool definitions.
server = MCPServer()
tools = server.tools.values()
table = Table(show_header=True, header_style="bold magenta")
table.add_column("Tool Name", style="dim", width=30)
table.add_column("Description")
for tool in sorted(tools, key=lambda t: t['name']):
table.add_row(tool['name'], tool['description'])
console.print(table)
except ValueError as e:
console.print(f"[bold red]Error loading tools:[/bold red] {e}")
console.print("Please ensure your database is configured correctly.")
raise typer.Exit(code=1) from e
except Exception as e:
console.print(f"[bold red]An unexpected error occurred:[/bold red] {e}")
raise typer.Exit(code=1) from e
# Abbreviation for mcp setup
@app.command("m", rich_help_panel="Shortcuts")
def mcp_setup_alias():
"""Shortcut for 'cgc mcp setup'"""
mcp_setup()
# Create Neo4j command group
neo4j_app = typer.Typer(help="Neo4j database configuration commands")
app.add_typer(neo4j_app, name="neo4j")
@neo4j_app.command("setup")
def neo4j_setup():
"""
Configure Neo4j Database Connection.
Choose from multiple setup options:
- Local (Docker-based, recommended)
- Local (Binary installation on Linux)
- Hosted (Neo4j AuraDB or remote instance)
- Connect to existing Neo4j instance
Note: This is optional. CodeGraphContext works with FalkorDB by default.
"""
console.print("\n[bold cyan]Neo4j Database Setup[/bold cyan]")
console.print("Configure Neo4j database connection for CodeGraphContext.\n")
run_neo4j_setup_wizard()
# Abbreviation for neo4j setup
@app.command("n", rich_help_panel="Shortcuts")
def neo4j_setup_alias():
"""Shortcut for 'cgc neo4j setup'"""
neo4j_setup()
# Create Context command group
context_app = typer.Typer(help="Manage Contexts (logical workspaces) and Mode")
app.add_typer(context_app, name="context")
@context_app.command("list")
def context_list():
"""List all available contexts and current mode."""
cfg = config_manager.load_context_config()
console.print(f"\n[bold]Current Mode:[/bold] {cfg.mode}")
if cfg.mode == "named":
console.print(f"[bold]Default Context:[/bold] {cfg.default_context or '<none>'}")
contexts = config_manager.list_contexts()
if not contexts:
console.print("\n[yellow]No custom contexts defined. Using global default.[/yellow]")
return
table = Table(title="\nConfigured Contexts")
table.add_column("Name", style="cyan")
table.add_column("Database", style="green")
table.add_column("DB Path", style="dim")
table.add_column("Repos Linked", justify="right")
for ctx in contexts:
marker = " *" if ctx.name == cfg.default_context else ""
table.add_row(
f"{ctx.name}{marker}",
ctx.database,
ctx.db_path,
str(len(ctx.repos))
)
console.print(table)
console.print("[dim] * indicates default context[/dim]\n")
@context_app.command("create")
def context_create(
name: str = typer.Argument(..., help="Name of the new context"),
database: str = typer.Option(None, "--database", "--db", "-db", "-d", help=config_manager.DATABASE_CLI_HELP),
db_path: str = typer.Option(None, "--db-path", help="Explicit path for the DB (defaults to ~/.codegraphcontext/contexts/<name>/db)"),
):
"""Create a new logical context."""
if database is None:
database = config_manager.get_config_value("DEFAULT_DATABASE") or "falkordb"
config_manager.create_context(name, database, db_path)
@context_app.command("delete")
def context_delete(
name: str = typer.Argument(..., help="Name of the context to delete")
):
"""Delete a context from the registry."""
if typer.confirm(f"Are you sure you want to delete context '{name}'? DB files will remain on disk."):
config_manager.delete_context(name)
@context_app.command("mode")
def context_mode(
mode: str = typer.Argument(..., help="Mode to switch to (global, per-repo, named)"),
):
"""Set the system-wide context mode."""
config_manager.set_context_mode(mode.lower())
@context_app.command("default")
def context_default(
name: str = typer.Argument(..., help="Name of the context to set as default"),
):
"""Set the default named context (used when --context is omitted in named mode)."""
config_manager.set_default_context(name)
# ============================================================================
# CREDENTIALS LOADING PRECEDENCE
# ============================================================================
def _load_credentials(cli_context_flag: Optional[str] = None):
"""
Loads configuration and credentials from various sources into environment variables.
Uses per-variable precedence - each variable is loaded from the highest priority source.
Priority order (highest to lowest):
1. Runtime environment variables (shell/CI)
2. Local `.codegraphcontext/.env` and `.env` in the current project directory (per-repo mode only)
3. Global `~/.codegraphcontext/.env` (user defaults, including `cgc config set`)
4. Local `mcp.json` env vars (project defaults)
Duplicate loading is skipped when the local file resolves to the same path as the global file.
Arbitrary parent directory `.env` files are not loaded—ensuring isolation.
"""
from dotenv import dotenv_values
from codegraphcontext.cli.config_manager import (
ensure_config_dir,
codegraphcontext_dotenv_at_cwd,
normalize_config_path,
)
# Ensure config directory exists (lazy initialization)
ensure_config_dir()
# Snapshot runtime environment BEFORE merging config files.
# These values must remain highest priority.
runtime_env = dict(os.environ)
# Collect all config sources in precedence order (lowest to highest)
config_sources = []
config_source_names = []
key_source_map = {}
key_defined_in = {}
def _append_source(source_name: str, source_values: dict):
if not source_values:
return
config_sources.append(source_values)
config_source_names.append(source_name)
for k, v in source_values.items():
if v is None:
continue
key_source_map[k] = source_name
key_defined_in.setdefault(k, []).append(source_name)
# 4. Local mcp.json (lowest priority - project defaults)
mcp_file_path = Path.cwd() / "mcp.json"
if mcp_file_path.exists():
try:
with open(mcp_file_path, "r", encoding="utf-8", errors="replace") as f:
mcp_config = json.load(f)
server_env = mcp_config.get("mcpServers", {}).get("CodeGraphContext", {}).get("env", {})
if isinstance(server_env, dict):
normalized_env = {}
for env_key, env_value in server_env.items():
if env_value is not None and "PATH" in env_key:
normalized_env[env_key] = normalize_config_path(str(env_value), absolute=True)
else:
normalized_env[env_key] = env_value
server_env = normalized_env
_append_source("mcp.json", server_env)
except Exception as e:
console.print(f"[yellow]Warning: Could not load mcp.json: {e}[/yellow]")
# 3. Global .env file (user defaults)
global_env_path = Path.home() / ".codegraphcontext" / ".env"
if global_env_path.exists():
try:
with open(global_env_path, "r", encoding="utf-8", errors="replace") as f:
_append_source(str(global_env_path), dotenv_values(stream=f))
except Exception as e:
console.print(f"[yellow]Warning: Could not load global .env: {e}[/yellow]")
# 2. Local project .env (only when cwd is under HOME, or CGC_LOAD_PROJECT_ENV=1)
if config_manager.should_apply_project_dotenv():
try:
local_dot_env = Path.cwd() / ".env"
if local_dot_env.exists() and local_dot_env.resolve() != global_env_path.resolve():
with open(local_dot_env, "r", encoding="utf-8", errors="replace") as f:
_append_source(str(local_dot_env), dotenv_values(stream=f))
except Exception as e:
console.print(f"[yellow]Warning: Could not load .env from current directory: {e}[/yellow]")
# <cwd>/.codegraphcontext/.env only (overrides global when distinct)
try:
local_cgc_env = codegraphcontext_dotenv_at_cwd(Path.cwd())
if local_cgc_env and local_cgc_env.resolve() != global_env_path.resolve():
with open(local_cgc_env, "r", encoding="utf-8", errors="replace") as f:
vals = dotenv_values(stream=f)
_append_source(str(local_cgc_env), vals)
except Exception as e:
console.print(
f"[yellow]Warning: Could not load .codegraphcontext/.env at cwd: {e}[/yellow]"
)
# Merge all configs with proper precedence (later sources override earlier ones)
merged_config = {}
for config in config_sources:
merged_config.update(config)
# Apply merged config to environment, but never override runtime env.
# Apply merged config to environment.
# IMPORTANT: DB-selection keys set in the shell must win over .env defaults.
# E.g. `DEFAULT_DATABASE=falkordb cgc index …` must not be overridden by
# DEFAULT_DATABASE=neo4j sitting in ~/.codegraphcontext/.env
for key, value in merged_config.items():
if value is not None: # Only set non-None values
if key in runtime_env:
continue
if "PATH" in key:
value = normalize_config_path(str(value), absolute=True)
os.environ[key] = str(value)
# Report what was loaded
if config_source_names:
if len(config_source_names) == 1:
console.print(f"[dim]Loaded configuration from: {config_source_names[-1]}[/dim]")
else:
console.print(f"[dim]Loaded configuration from: {', '.join(config_source_names)}[/dim]")
else:
console.print("[yellow]No configuration file found. Using defaults.[/yellow]")
default_db_sources = list(key_defined_in.get("DEFAULT_DATABASE", []))
if "DEFAULT_DATABASE" in runtime_env:
default_db_sources.append("environment")
if len(default_db_sources) > 1:
winners = "environment" if "DEFAULT_DATABASE" in runtime_env else key_source_map.get("DEFAULT_DATABASE", "defaults")
console.print(
"[dim]DEFAULT_DATABASE defined in multiple sources: "
f"{', '.join(default_db_sources)}; using: {winners}[/dim]"
)
# Detect the context to see if it specifies a custom database
if cli_context_flag is None:
import sys
for i, arg in enumerate(sys.argv):
if arg in ("--context", "-c"):
if i + 1 < len(sys.argv):
cli_context_flag = sys.argv[i + 1]
break
elif arg.startswith("--context="):
cli_context_flag = arg.split("=", 1)[1]
break
from codegraphcontext.cli.config_manager import resolve_context
ctx = None
try:
ctx = resolve_context(cli_context_flag)
except Exception:
pass
# Determine if there is a runtime database override.
runtime_db = os.environ.get("CGC_RUNTIME_DB_TYPE")
has_runtime_override = (
runtime_db is not None
or "DATABASE_TYPE" in runtime_env
or "DEFAULT_DATABASE" in runtime_env
)
# If there is no runtime override, but the context defines a database,
# set DEFAULT_DATABASE to the context database to ensure that's what gets initialized.
if not has_runtime_override and ctx and ctx.mode != "global" and ctx.database:
os.environ["DEFAULT_DATABASE"] = ctx.database
# Now select the database based on precedence:
# 1. CGC_RUNTIME_DB_TYPE
# 2. DATABASE_TYPE or DEFAULT_DATABASE from runtime environment (shell variables)
# 3. Context database
# 4. DATABASE_TYPE or DEFAULT_DATABASE from merged config files (.env files)
# 5. Auto-detect fallback
if runtime_db:
default_db = runtime_db.lower()
db_source = "runtime-env (CGC_RUNTIME_DB_TYPE)"
elif "DATABASE_TYPE" in runtime_env:
default_db = runtime_env["DATABASE_TYPE"].lower()
db_source = "environment (DATABASE_TYPE)"
elif "DEFAULT_DATABASE" in runtime_env:
default_db = runtime_env["DEFAULT_DATABASE"].lower()
db_source = "environment (DEFAULT_DATABASE)"
elif not has_runtime_override and ctx and ctx.mode != "global" and ctx.database:
default_db = ctx.database.lower()
db_source = f"context ({ctx.context_name or 'resolved'})"
elif os.environ.get("DATABASE_TYPE") and "DATABASE_TYPE" in key_source_map:
default_db = os.environ["DATABASE_TYPE"].lower()
db_source = key_source_map["DATABASE_TYPE"]
elif os.environ.get("DEFAULT_DATABASE") and "DEFAULT_DATABASE" in key_source_map:
default_db = os.environ["DEFAULT_DATABASE"].lower()
db_source = key_source_map["DEFAULT_DATABASE"]
else:
# No explicit choice — ask the factory which backend it will use
try:
from codegraphcontext.core import get_database_manager
_mgr = get_database_manager()
default_db = _mgr.get_backend_type() # e.g. 'falkordb' / 'kuzudb'
except Exception:
# Factory failed entirely — still show a best-guess
from codegraphcontext.core import _is_falkordb_available
default_db = "falkordb" if _is_falkordb_available() else "kuzudb"
db_source = "auto-detect"
# Print selection banner
if default_db == "neo4j":
has_neo4j_creds = all([
os.environ.get("NEO4J_URI"),
os.environ.get("NEO4J_USERNAME"),
os.environ.get("NEO4J_PASSWORD")
])
if has_neo4j_creds:
neo4j_db = os.environ.get("NEO4J_DATABASE")
if neo4j_db:
console.print(f"[cyan]Using database: neo4j (source: {db_source}, database: {neo4j_db})[/cyan]")
else:
console.print(f"[cyan]Using database: neo4j (source: {db_source})[/cyan]")
else:
console.print("[yellow]⚠ DEFAULT_DATABASE=neo4j but credentials not found. Falling back to default.[/yellow]")
elif default_db == "falkordb":
console.print(f"[cyan]Using database: falkordb (source: {db_source})[/cyan]")
elif default_db == "kuzudb":
console.print(f"[cyan]Using database: kuzudb (source: {db_source})[/cyan]")
elif default_db == "ladybugdb":
console.print(f"[cyan]Using database: ladybugdb (source: {db_source})[/cyan]")
elif default_db == "falkordb-remote":
host = os.environ.get("FALKORDB_HOST")
if host:
console.print(f"[cyan]Using database: falkordb-remote (source: {db_source}, host: {host})[/cyan]")
else:
console.print("[yellow]⚠ DATABASE_TYPE=falkordb-remote but FALKORDB_HOST not set.[/yellow]")
else:
console.print(f"[cyan]Using database: {default_db} (source: {db_source})[/cyan]")
# Persist selection metadata for downstream diagnostics and error messages.
os.environ["CGC_SELECTED_DATABASE"] = default_db
os.environ["CGC_DB_SELECTION_SOURCE"] = db_source
# ============================================================================
# CONFIG COMMAND GROUP
# ============================================================================
config_app = typer.Typer(help="Manage configuration settings")
app.add_typer(config_app, name="config")
@config_app.command("show")
def config_show():
"""
Display current configuration settings.
Shows all configuration values including database, indexing options,
logging settings, and performance tuning parameters.
"""
config_manager.show_config()
@config_app.command("set")
def config_set(
key: str = typer.Argument(..., help="Configuration key to set"),
value: str = typer.Argument(..., help="Value to set")
):
"""
Set a configuration value.
Examples:
cgc config set DEFAULT_DATABASE neo4j
cgc config set INDEX_VARIABLES false
cgc config set MAX_FILE_SIZE_MB 20
cgc config set DEBUG_LOGS true
"""
if not config_manager.set_config_value(key, value):
raise typer.Exit(code=1)
@config_app.command("reset")
def config_reset():
"""
Reset all configuration to default values.
This will restore all settings to their defaults.
Your current configuration will be backed up.
"""
if typer.confirm("Are you sure you want to reset all configuration to defaults?", default=False):
config_manager.reset_config()
else:
console.print("[yellow]Reset cancelled[/yellow]")
@config_app.command("db")
def config_db(backend: str = typer.Argument(..., help="Database backend: 'neo4j', 'falkordb', 'falkordb-remote', 'kuzudb', 'nornic', or 'ladybugdb'")):
"""
Quickly switch the default database backend.
Shortcut for 'cgc config set DEFAULT_DATABASE <backend>'.
Examples:
cgc config db neo4j
cgc config db falkordb
cgc config db kuzudb
"""
backend = backend.lower()
if backend not in ['falkordb', 'falkordb-remote', 'neo4j', 'kuzudb', 'nornic', 'ladybugdb']:
console.print(f"[bold red]Invalid backend: {backend}[/bold red]")
console.print("Must be 'falkordb', 'falkordb-remote', 'neo4j', 'kuzudb', 'nornic', or 'ladybugdb'")
raise typer.Exit(code=1)
updated = config_manager.set_config_value("DEFAULT_DATABASE", backend)
if not updated:
console.print(f"[bold red]Failed to switch default database to {backend}[/bold red]")
raise typer.Exit(code=1)
console.print(f"[green]✔ Default database switched to {backend}[/green]")
# ============================================================================
# PROMPT COMMAND GROUP - Custom LLM Prompts
# ============================================================================
prompt_app = typer.Typer(help="Manage custom LLM prompt files")
app.add_typer(prompt_app, name="prompt")
@prompt_app.command("add")
def prompt_add(
path: str = typer.Argument(..., help="Path to the prompt file to register")
):
"""
Add a custom prompt file to the project.
Registers a prompt file that will be injected into the LLM system prompt.
The file path is stored relative to the project root.
Examples:
cgc prompt add skills.md
cgc prompt add docs/custom-instructions.txt
cgc prompt add /absolute/path/to/prompt.md
"""
try:
success = project_config.add_prompt_file(path)
if not success:
raise typer.Exit(code=1)
except Exception as e:
console.print(f"[red]Error adding prompt file: {e}[/red]")
raise typer.Exit(code=1)
@prompt_app.command("list")
def prompt_list():
"""
List all registered prompt files.
Shows all custom prompt files that will be injected into the LLM system prompt.
Files are shown in the order they will be prepended.
"""
try:
prompts = project_config.list_prompt_files()
if not prompts:
console.print("[yellow]No custom prompt files registered.[/yellow]")
console.print("\nUse [cyan]cgc prompt add <path>[/cyan] to register a prompt file.")
return
console.print("[bold cyan]Registered Prompt Files:[/bold cyan]\n")
table = Table(show_header=True, header_style="bold magenta")
table.add_column("#", style="dim", width=3)
table.add_column("Path", style="green")
table.add_column("Status", style="cyan", width=10)
project_root = project_config.get_project_root()
for i, prompt_path in enumerate(prompts, 1):
# Check if file exists
prompt_file = Path(prompt_path)
if not prompt_file.is_absolute():
prompt_file = project_root / prompt_file
status = "✅ Found" if prompt_file.exists() else "⚠️ Missing"
table.add_row(str(i), prompt_path, status)
console.print(table)
config_file = project_config.get_project_config_file()
console.print(f"\n[dim]Config: {config_file}[/dim]")
except Exception as e:
console.print(f"[red]Error listing prompt files: {e}[/red]")
raise typer.Exit(code=1)
@prompt_app.command("remove")
def prompt_remove(
path: str = typer.Argument(..., help="Path to the prompt file to unregister")
):
"""
Remove a custom prompt file from the project.
Unregisters a prompt file so it will no longer be injected into the LLM system prompt.
Examples:
cgc prompt remove skills.md
cgc prompt remove docs/custom-instructions.txt
"""
try:
success = project_config.remove_prompt_file(path)
if not success:
raise typer.Exit(code=1)
except Exception as e:
console.print(f"[red]Error removing prompt file: {e}[/red]")
raise typer.Exit(code=1)
# ============================================================================
# BUNDLE COMMAND GROUP - Pre-indexed Graph Snapshots
# ============================================================================
bundle_app = typer.Typer(help="Create and load pre-indexed graph bundles")
app.add_typer(bundle_app, name="bundle")
@bundle_app.command("export")
def bundle_export(
output: str = typer.Argument(..., help="Output path for the .cgc bundle file"),
repo: Optional[str] = typer.Option(None, "--repo", "-r", help="Specific repository path to export (default: export all)"),
no_stats: bool = typer.Option(False, "--no-stats", help="Skip statistics generation"),
sign_key: Optional[str] = typer.Option(None, "--sign-key", envvar="CGC_BUNDLE_SIGN_KEY", help="HMAC signing key (or set CGC_BUNDLE_SIGN_KEY)"),
encrypt_password: Optional[str] = typer.Option(None, "--encrypt-password", envvar="CGC_BUNDLE_PASSWORD", help="Encrypt bundle with this password (or set CGC_BUNDLE_PASSWORD)", hide_input=True),
exclude_labels: Optional[str] = typer.Option(None, "--exclude-labels", help="Comma-separated node labels to leave out of the bundle, with their edges (e.g. DbTable,ExternalClass) (#1323)"),
context: Optional[str] = typer.Option(None, "--context", "-c", help="Specific context to use"),
):
"""
Export the current graph to a portable .cgc bundle.
Creates a pre-indexed graph snapshot that can be distributed and loaded
instantly without re-indexing. Perfect for sharing famous repositories.
Examples:
cgc bundle export numpy.cgc --repo /path/to/numpy
cgc bundle export my-project.cgc
cgc bundle export all-repos.cgc --no-stats
"""
_load_credentials()
from codegraphcontext.core.cgc_bundle import CGCBundle
# Typer resolves defaults only when *it* invokes the command. Called as a
# plain function (tests/integration/test_parser_goldens.py does this, as can
# any programmatic caller), an omitted option keeps its OptionInfo sentinel
# -- which is truthy, so `if sign_key:` passes and `sign_key.encode()` then
# raises AttributeError. These two are normalized rather than merely
# forwarded because they are the only options here that get dereferenced.
if not isinstance(sign_key, (str, type(None))):
sign_key = None
if not isinstance(encrypt_password, (str, type(None))):
encrypt_password = None
services = _initialize_services(context)
if not all(services[:3]):
raise typer.Exit(code=1)
db_manager, _, code_finder = services[:3]
try:
output_path = Path(output)
repo_path = Path(repo).resolve() if repo else None
console.print(f"[cyan]Exporting graph to {output_path}...[/cyan]")
if repo_path:
console.print(f"[dim]Repository: {repo_path}[/dim]")
else:
console.print("[dim]Exporting all repositories[/dim]")
bundle = CGCBundle(db_manager)
success, message = bundle.export_to_bundle(
output_path,
repo_path=repo_path,
include_stats=not no_stats,
sign_key=sign_key,
encrypt_password=encrypt_password,
# bundle_export is also called programmatically (the golden
# harness does), where unpassed Typer options arrive as OptionInfo
# objects rather than their defaults — same trap the CLI meta-test
# documents for other commands.
exclude_labels=[
l for l in (exclude_labels if isinstance(exclude_labels, str) else "").split(",")
if l.strip()
],
)
if success:
console.print(f"[bold green]{message}[/bold green]")
else:
console.print(f"[bold red]Export failed: {message}[/bold red]")
raise typer.Exit(code=1)
finally:
db_manager.close_driver()
def _confirm_bundle_clear(clear: bool, yes: bool) -> bool:
"""Return True if import may proceed; False if user cancelled."""
if not clear:
return True
console.print("[yellow]⚠️ Warning: This will clear all existing graph data![/yellow]")
if yes:
return True
if not sys.stdin.isatty():
console.print(
"[bold red]Refusing to clear graph in non-interactive mode. "
"Pass --yes / -y to confirm.[/bold red]"
)
raise typer.Exit(code=1)
if not typer.confirm("Are you sure you want to continue?", default=False):
console.print("[yellow]Import cancelled[/yellow]")
return False
return True
@bundle_app.command("import")
def bundle_import(
bundle_file: str = typer.Argument(..., help="Path to the .cgc bundle file to import"),
clear: bool = typer.Option(False, "--clear", help="Clear existing graph data before importing"),
password: Optional[str] = typer.Option(None, "--password", envvar="CGC_BUNDLE_PASSWORD", help="Password for encrypted bundles (or set CGC_BUNDLE_PASSWORD)", hide_input=True),
verify_key: Optional[str] = typer.Option(None, "--verify-key", envvar="CGC_BUNDLE_VERIFY_KEY", help="HMAC verification key for signed bundles (or set CGC_BUNDLE_VERIFY_KEY)"),
yes: bool = typer.Option(False, "--yes", "-y", help="Skip confirmation when using --clear"),
context: Optional[str] = typer.Option(None, "--context", "-c", help="Specific context to use"),
):
"""
Import a .cgc bundle into the current database.
Loads a pre-indexed graph snapshot into your database. Use --clear to
replace all existing data with the bundle contents.
Examples:
cgc bundle import numpy.cgc
cgc bundle import my-project.cgc --clear --yes
"""
_load_credentials()
from codegraphcontext.core.cgc_bundle import CGCBundle
services = _initialize_services(context)
if not all(services[:3]):
raise typer.Exit(code=1)
db_manager, graph_builder, code_finder = services[:3]
try:
bundle_path = Path(bundle_file)
if not bundle_path.exists():
console.print(f"[bold red]Bundle file not found: {bundle_path}[/bold red]")
raise typer.Exit(code=1)
if not _confirm_bundle_clear(clear, yes):
return
console.print(f"[cyan]Importing bundle from {bundle_path}...[/cyan]")
bundle = CGCBundle(db_manager)
success, message = bundle.import_from_bundle(
bundle_path,
clear_existing=clear,
password=password,
verify_key=verify_key,
)
if success:
console.print(f"[bold green]{message}[/bold green]")
else:
console.print(f"[bold red]Import failed: {message}[/bold red]")
raise typer.Exit(code=1)
finally:
db_manager.close_driver()
@bundle_app.command("verify")
def bundle_verify(
bundle_file: str = typer.Argument(..., help="Path to the .cgc bundle file to verify"),
password: Optional[str] = typer.Option(None, "--password", envvar="CGC_BUNDLE_PASSWORD", help="Password for encrypted bundles (or set CGC_BUNDLE_PASSWORD)", hide_input=True),
verify_key: Optional[str] = typer.Option(None, "--verify-key", envvar="CGC_BUNDLE_VERIFY_KEY", help="HMAC verification key for signed bundles (or set CGC_BUNDLE_VERIFY_KEY)"),
):
"""Verify bundle structure, checksums, optional signature, and encryption envelope."""
from codegraphcontext.core.cgc_bundle import CGCBundle
bundle = CGCBundle(None)
success, message = bundle.verify_bundle(Path(bundle_file), password=password, verify_key=verify_key)
if success:
console.print(f"[bold green]Bundle verified:[/bold green] {message}")
else:
console.print(f"[bold red]Bundle verification failed:[/bold red] {message}")
raise typer.Exit(code=1)
@bundle_app.command("inspect")
def bundle_inspect(
bundle_file: str = typer.Argument(..., help="Path to the .cgc bundle file to inspect"),
password: Optional[str] = typer.Option(None, "--password", envvar="CGC_BUNDLE_PASSWORD", help="Password for encrypted bundles (or set CGC_BUNDLE_PASSWORD)", hide_input=True),
verify_key: Optional[str] = typer.Option(None, "--verify-key", envvar="CGC_BUNDLE_VERIFY_KEY", help="HMAC verification key for signed bundles (or set CGC_BUNDLE_VERIFY_KEY)"),
json_output: bool = typer.Option(False, "--json", help="Print raw JSON inspection output"),
):
"""Inspect bundle metadata without importing it."""
from codegraphcontext.core.cgc_bundle import CGCBundle
bundle = CGCBundle(None)
success, info = bundle.inspect_bundle(Path(bundle_file), password=password, verify_key=verify_key)
if not success:
console.print(f"[bold red]Inspect failed:[/bold red] {info.get('error', 'unknown error')}")
raise typer.Exit(code=1)
if json_output:
console.print_json(data=info)
return
metadata = info.get("metadata", {})
stats = info.get("stats", {})
graph_metrics = metadata.get("graph_metrics", {})
table = Table(title=f"Bundle: {Path(bundle_file).name}", show_header=False)
table.add_column("Field", style="cyan")
table.add_column("Value", overflow="fold")
table.add_row("Repository", str(metadata.get("repo", "unknown")))
table.add_row("Name", str(metadata.get("name", Path(bundle_file).name)))
table.add_row("Format", str(metadata.get("format_version", metadata.get("cgc_version", "unknown"))))
table.add_row("Exported", str(metadata.get("exported_at", "unknown")))
table.add_row("Nodes", str(graph_metrics.get("total_nodes", stats.get("node_count", "unknown"))))
table.add_row("Edges", str(graph_metrics.get("total_edges", stats.get("edge_count", "unknown"))))
table.add_row("Encrypted", "yes" if info.get("encrypted") else "no")
table.add_row("Signed", "yes" if info.get("signed") else "no")
table.add_row("Valid", "yes" if info.get("valid") else f"no ({info.get('validation')})")
console.print(table)
@bundle_app.command("diff")
def bundle_diff(
left_bundle: str = typer.Argument(..., help="Older/base .cgc bundle"),
right_bundle: str = typer.Argument(..., help="Newer/target .cgc bundle"),
left_password: Optional[str] = typer.Option(None, "--left-password", help="Password for the left encrypted bundle", hide_input=True),
right_password: Optional[str] = typer.Option(None, "--right-password", help="Password for the right encrypted bundle", hide_input=True),
left_verify_key: Optional[str] = typer.Option(None, "--left-verify-key", help="HMAC verification key for the left signed bundle"),
right_verify_key: Optional[str] = typer.Option(None, "--right-verify-key", help="HMAC verification key for the right signed bundle"),
json_output: bool = typer.Option(False, "--json", help="Print raw JSON diff output"),
limit: int = typer.Option(20, "--limit", help="Maximum changed keys to show per category"),
):
"""Compare two .cgc bundles without importing them."""
from codegraphcontext.core.cgc_bundle import CGCBundle
bundle = CGCBundle(None)
success, diff = bundle.diff_bundles(
Path(left_bundle),
Path(right_bundle),
left_password=left_password or os.environ.get("CGC_BUNDLE_PASSWORD"),
right_password=right_password or os.environ.get("CGC_BUNDLE_PASSWORD"),
left_verify_key=left_verify_key or os.environ.get("CGC_BUNDLE_VERIFY_KEY"),
right_verify_key=right_verify_key or os.environ.get("CGC_BUNDLE_VERIFY_KEY"),
)
if not success:
console.print(f"[bold red]Diff failed:[/bold red] {diff.get('error', 'unknown error')}")
raise typer.Exit(code=1)
if json_output:
console.print_json(data=diff)
return
table = Table(title="Bundle Diff")
table.add_column("Category", style="cyan")
table.add_column("Added", justify="right", style="green")
table.add_column("Removed", justify="right", style="red")
table.add_column("Changed", justify="right", style="yellow")
for category in ("nodes", "edges"):
item = diff[category]
table.add_row(category, str(len(item["added"])), str(len(item["removed"])), str(len(item["changed"])))
console.print(table)
for category in ("nodes", "edges"):
item = diff[category]
samples = []
for label in ("added", "removed", "changed"):
values = item[label][:limit]
if values:
samples.append(f"[bold]{category} {label}[/bold]\n" + "\n".join(f" {value}" for value in values))
if samples:
console.print("\n".join(samples))
@bundle_app.command("load")
def bundle_load(
bundle_name: str = typer.Argument(..., help="Bundle name or path to load (e.g., 'numpy' or 'numpy.cgc')"),
clear: bool = typer.Option(False, "--clear", help="Clear existing graph data before loading"),
password: Optional[str] = typer.Option(None, "--password", envvar="CGC_BUNDLE_PASSWORD", help="Password for encrypted bundles (or set CGC_BUNDLE_PASSWORD)", hide_input=True),
verify_key: Optional[str] = typer.Option(None, "--verify-key", envvar="CGC_BUNDLE_VERIFY_KEY", help="HMAC verification key for signed bundles (or set CGC_BUNDLE_VERIFY_KEY)"),
yes: bool = typer.Option(False, "--yes", "-y", help="Skip confirmation when using --clear"),
context: Optional[str] = typer.Option(None, "--context", "-c", help="Specific context to use"),
):
"""
Load a pre-indexed bundle (download if needed, then import).
This is a convenience command that will:
1. Check if the bundle exists locally
2. Download from registry if not found
3. Import the bundle into the database
Examples:
cgc load numpy
cgc load numpy.cgc --clear
cgc load /path/to/bundle.cgc
"""
_load_credentials()
bundle_path = Path(bundle_name)
# If it's an absolute path or has .cgc extension and exists, use it directly
if bundle_path.is_absolute() or (bundle_path.suffix == '.cgc' and bundle_path.exists()):
bundle_import(str(bundle_path), clear=clear, password=password, verify_key=verify_key, yes=yes, context=context)
return
# Add .cgc extension if not present