codegraph-nav 0.1.0__py3-none-any.whl

codegraph_nav/cli.py

@@ -0,0 +1,223 @@
+#!/usr/bin/env python3
+"""Unified CLI for codegraph-nav.
+
+This module provides a single entry point `codegraph-nav` with subcommands for all
+codegraph-nav functionality:
+    - codegraph-nav map (or scan): Generate a code map of a codebase
+    - codegraph-nav search: Search for symbols in the code map
+    - codegraph-nav read: Read specific lines from files
+    - codegraph-nav stats: Show codebase statistics (shortcut for search --stats)
+    - codegraph-nav completion: Generate shell completion scripts
+    - codegraph-nav watch: Watch for changes and auto-update map
+    - codegraph-nav export: Export code map to different formats
+
+Example:
+    $ codegraph-nav map /path/to/project -o .codegraph.json
+    $ codegraph-nav search "UserService" --type class
+    $ codegraph-nav read src/api.py 45-60
+    $ codegraph-nav stats
+    $ codegraph-nav completion bash > ~/.bash_completion.d/codegraph-nav
+    $ codegraph-nav watch /path/to/project
+    $ codegraph-nav export -f markdown -o docs/codebase.md
+"""
+
+import argparse
+import sys
+
+from . import __version__
+from .code_navigator import add_map_arguments, run_map
+from .code_search import add_search_arguments, run_search
+from .completions import run_completion
+from .exporters import run_export
+from .line_reader import add_read_arguments, run_read
+from .watcher import run_watch
+
+
+def main():
+    """Unified command-line interface for codegraph-nav.
+
+    Usage:
+        codegraph-nav map PATH [-o OUTPUT] [-i IGNORE...] [--compact]
+        codegraph-nav search QUERY [--type TYPE] [--file PATTERN] [--limit N]
+        codegraph-nav read FILE LINES [-c CONTEXT] [--symbol]
+        codegraph-nav stats [-m MAP] [--compact]
+        codegraph-nav completion SHELL
+        codegraph-nav watch PATH [-o OUTPUT] [--debounce N]
+        codegraph-nav export -f FORMAT [-o OUTPUT]
+
+    Example:
+        $ codegraph-nav map /my/project -o .codegraph.json
+        $ codegraph-nav search "payment" --type function
+        $ codegraph-nav read src/api.py 45-60 -c 2
+        $ codegraph-nav stats
+        $ codegraph-nav completion bash > ~/.bash_completion.d/codegraph-nav
+        $ codegraph-nav watch /my/project
+        $ codegraph-nav export -f markdown -o docs/codebase.md
+    """
+    parser = argparse.ArgumentParser(
+        prog="codegraph-nav",
+        description="Token-efficient code navigation - reduce token usage by 97%",
+        epilog="Run 'codegraph-nav <command> --help' for more information on a command.",
+    )
+    parser.add_argument("-v", "--version", action="version", version=f"%(prog)s {__version__}")
+
+    subparsers = parser.add_subparsers(dest="command", metavar="<command>")
+
+    # codegraph-nav map / codegraph-nav scan (alias)
+    map_parser = subparsers.add_parser(
+        "map",
+        aliases=["scan"],
+        help="Generate a code map of a codebase",
+        description="Scan a codebase and generate a JSON index of all symbols.",
+        epilog="Example: codegraph-nav map /my/project -o .codegraph.json",
+    )
+    add_map_arguments(map_parser)
+
+    # codegraph-nav search
+    search_parser = subparsers.add_parser(
+        "search",
+        help="Search for symbols in the code map",
+        description="Search through a code map for symbols, files, and dependencies.",
+        epilog='Example: codegraph-nav search "payment" --type function',
+    )
+    add_search_arguments(search_parser)
+
+    # codegraph-nav read
+    read_parser = subparsers.add_parser(
+        "read",
+        help="Read specific lines from files",
+        description="Read specific lines or ranges from files for token-efficient viewing.",
+        epilog="Example: codegraph-nav read src/api.py 45-60 -c 2",
+    )
+    add_read_arguments(read_parser)
+
+    # codegraph-nav stats (shortcut for search --stats)
+    stats_parser = subparsers.add_parser(
+        "stats",
+        help="Show codebase statistics (shortcut for search --stats)",
+        description="Display statistics about the indexed codebase.",
+        epilog="Example: codegraph-nav stats -m .codegraph.json",
+    )
+    stats_parser.add_argument(
+        "-m",
+        "--map",
+        default=".codegraph.json",
+        help="Path to code map file (default: .codegraph.json)",
+    )
+    stats_parser.add_argument(
+        "--compact", action="store_true", help="Output compact JSON (default: pretty-printed)"
+    )
+    stats_parser.add_argument(
+        "-o",
+        "--output",
+        choices=["json", "table"],
+        default="json",
+        help="Output format (default: json)",
+    )
+    stats_parser.add_argument("--no-color", action="store_true", help="Disable colored output")
+
+    # codegraph-nav completion
+    completion_parser = subparsers.add_parser(
+        "completion",
+        help="Generate shell completion script",
+        description="Generate autocompletion script for bash or zsh.",
+        epilog="Example: codegraph-nav completion bash > ~/.bash_completion.d/codegraph-nav",
+    )
+    completion_parser.add_argument(
+        "shell",
+        choices=["bash", "zsh"],
+        help="Shell type (bash or zsh)",
+    )
+
+    # codegraph-nav watch
+    watch_parser = subparsers.add_parser(
+        "watch",
+        help="Watch for changes and auto-update map",
+        description="Monitor a codebase for changes and automatically update the code map.",
+        epilog="Example: codegraph-nav watch /my/project -o .codegraph.json",
+    )
+    watch_parser.add_argument("path", help="Path to the codebase root directory")
+    watch_parser.add_argument(
+        "-o",
+        "--output",
+        default=".codegraph.json",
+        help="Output file path (default: .codegraph.json)",
+    )
+    watch_parser.add_argument("-i", "--ignore", nargs="*", help="Additional patterns to ignore")
+    watch_parser.add_argument(
+        "--git-only", action="store_true", help="Only scan files tracked by git"
+    )
+    watch_parser.add_argument(
+        "--use-gitignore", action="store_true", help="Also ignore patterns from .gitignore"
+    )
+    watch_parser.add_argument(
+        "--compact", action="store_true", help="Output compact JSON (default: pretty-printed)"
+    )
+    watch_parser.add_argument("--no-color", action="store_true", help="Disable colored output")
+    watch_parser.add_argument(
+        "--debounce",
+        type=float,
+        default=1.0,
+        help="Seconds to wait after change before updating (default: 1.0)",
+    )
+
+    # codegraph-nav export
+    export_parser = subparsers.add_parser(
+        "export",
+        help="Export code map to different formats",
+        description="Export the code map to Markdown, HTML, or GraphViz format.",
+        epilog="Example: codegraph-nav export -f markdown -o docs/codebase.md",
+    )
+    export_parser.add_argument(
+        "-m",
+        "--map",
+        default=".codegraph.json",
+        help="Path to code map file (default: .codegraph.json)",
+    )
+    export_parser.add_argument(
+        "-f",
+        "--format",
+        choices=["markdown", "md", "html", "graphviz", "dot"],
+        default="markdown",
+        help="Export format (default: markdown)",
+    )
+    export_parser.add_argument("-o", "--output", help="Output file (default: stdout)")
+    export_parser.add_argument("--no-color", action="store_true", help="Disable colored output")
+
+    args = parser.parse_args()
+
+    if args.command is None:
+        parser.print_help()
+        sys.exit(0)
+
+    if args.command in ("map", "scan"):
+        run_map(args)
+    elif args.command == "search":
+        run_search(args)
+    elif args.command == "read":
+        run_read(args)
+    elif args.command == "stats":
+        # Convert stats args to search args format
+        args.stats = True
+        args.query = None
+        args.type = None
+        args.file = None
+        args.files = False
+        args.structure = None
+        args.deps = None
+        args.limit = 10
+        args.no_fuzzy = False
+        args.check_stale = False
+        args.warn_stale = False
+        args.since_commit = None
+        run_search(args)
+    elif args.command == "completion":
+        run_completion(args.shell)
+    elif args.command == "watch":
+        run_watch(args)
+    elif args.command == "export":
+        run_export(args)
+
+
+if __name__ == "__main__":
+    main()