context-gen-cli 1.2.0__tar.gz → 1.2.5__tar.gz

{context_gen_cli-1.2.0 → context_gen_cli-1.2.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: context-gen-cli
-Version: 1.2.0
+Version: 1.2.5
 Summary: A modern CLI tool that scans any project, builds an AST-based dependency graph, and generates structured LLM context (agent.md / agent.json).
 Author: yakkshit
 License-Expression: MIT
@@ -25,7 +25,7 @@ Requires-Dist: pytest>=8.0.0; extra == "dev"
 Requires-Dist: build>=1.1.0; extra == "dev"
 Requires-Dist: twine>=5.0.0; extra == "dev"
 
-# ⚡ context-gen-cli (Python Edition)
+# ⚡ context-gen-cli (`ctx`) — Python Edition
 
 [![PyPI version](https://img.shields.io/pypi/v/context-gen-cli.svg?color=3775a9)](https://pypi.org/project/context-gen-cli/)
 [![Python Versions](https://img.shields.io/pypi/pyversions/context-gen-cli.svg)](https://pypi.org/project/context-gen-cli/)
@@ -37,13 +37,14 @@ Requires-Dist: twine>=5.0.0; extra == "dev"
 
 ## 🌟 Highlights
 
-- **100% Accurate Python Dependency Graphs**: Built using Python's native `ast` (Abstract Syntax Tree) module to resolve imports, relative packages, entry points, and utilities without regex guesswork.
+- **⚡ Short Command Alias (`ctx`)**: Type `ctx` anywhere in your terminal.
+- **100% Accurate Python Dependency Graphs**: Built using Python's native `ast` (Abstract Syntax Tree) module to resolve imports, relative packages, entry points, and utilities.
+- **📁 Clean Workspace Storage**: Everything (`agent.md`, `agent.json`, `agent.yaml`, `.context-gen.json`) is saved neatly inside `context/`.
 - **⚡ All-In-One Default Mode (`-d`)**: Auto-generates triple context formats in `context/` and runs a live auto-sync watcher in the background.
 - **`.gitignore` & Multi-Ignore Respect**: Automatically parses rules from `.gitignore`, `.npmignore`, `.dockerignore`, `.contextignore`, `.ignore`, and filters `.env*` secrets.
 - **Triple Format Output**: Generates Markdown (`agent.md`), MCP-compatible structured JSON (`agent.json`), and clean YAML (`agent.yaml`).
 - **🔄 Auto-Sync Watch Mode (`-w`)**: Monitors workspace changes and updates context files automatically on save.
-- **Configuration Parity**: Seamlessly reads `.context-gen.json` if present to maintain unified project settings with the Node.js edition.
-- **Modern CLI**: Styled with `typer` and `rich` for rich terminal output and progress reporting.
+- **Configuration Parity**: Seamlessly reads `context/.context-gen.json` to maintain unified project settings with the Node.js edition.
 
 ---
 
@@ -63,75 +64,52 @@ pip install context-gen-cli
 Generates all formats in `context/` and starts the live auto-sync watcher in background:
 
 ```bash
-context-gen -d
+ctx -d
 ```
 
 ### 2. Generate All Formats (Markdown, JSON, YAML)
 Scans the current directory and outputs `agent.md`, `agent.json`, and `agent.yaml` in `context/`:
 
 ```bash
-context-gen .
+ctx
 ```
 
-### 3. Generate Specific Format (JSON / MD / YAML)
-Generate only the format you need:
-
+### 3. Quick Refresh / Regenerate
 ```bash
-# Generate MCP-ready JSON
-context-gen . --format json
-
-# Generate Markdown
-context-gen . --format md
-
-# Generate YAML
-context-gen . --format yaml
+ctx update
 ```
 
-### 4. Watch Mode
-Keep context files fresh automatically on every file edit:
-
+### 4. Custom Format & Output Destination
 ```bash
-context-gen . --watch
+ctx update -f json
+ctx -o custom_docs/
+ctx -p /path/to/project
 ```
 
-### 5. Custom Output Destination & Directory Depth
+### 5. Watch Mode
+Keep context files fresh automatically on every file edit:
+
 ```bash
-context-gen ./my-project -o custom/docs/context.md --max-depth 4
+ctx -w
 ```
 
 ---
 
 ## 📖 CLI Reference
 
-```text
-Usage: context-gen [OPTIONS] [PATH]
-
-Arguments:
-  [PATH]    Target project directory to analyze  [default: .]
-
-Options:
-  -d, --default             ⚡ Zero-config default mode: generate all formats in context/ and run live auto-sync watcher
-  -f, --format [all|md|json|yaml]  Output format [default: all]
-  -o, --output PATH         Custom output file path (e.g. context/agent.md or custom.json)
-  -w, --watch               Watch directory and auto-regenerate context on file changes
-  --max-depth INTEGER       Maximum directory depth to scan (1-10) [default: 3]
-  --help                    Show this message and exit
-```
-
----
-
-## 🌐 Node.js & Live MCP Server
-
-Looking for the live MCP server with interactive SSE streaming and public tunnels? Check out the [Node.js edition](https://www.npmjs.com/package/context-gen-cli):
-
-```bash
-npx context-gen-cli -d
-# or
-npx context-gen-cli --mcp
-```
+| Flag / Command | Alias | Description |
+| :--- | :--- | :--- |
+| `ctx -d` | `ctx --default` | **⚡ All-in-One**: Generates context files and starts live auto-sync watcher |
+| `ctx -w` | `ctx --watch` | **👀 Watch Mode**: Auto-regenerates context on file changes |
+| `ctx -f <type>` | `ctx --format <type>` | **Format**: `md`, `json`, `yaml`, or `all` |
+| `ctx -o <path>` | `ctx --output <path>` | **Custom Output**: Output file/folder path |
+| `ctx -p <path>` | `ctx --project <path>` | **Target Directory**: Directory to analyze |
+| `ctx update` | — | **Refresh**: Regenerate context files |
+| `ctx --help` | — | View full help options |
 
 ---
 
 ## 📄 License
 
 MIT © [yakkshit](https://github.com/yakkshit)
+

{context_gen_cli-1.2.0 → context_gen_cli-1.2.5}/README.md

@@ -1,4 +1,4 @@
-# ⚡ context-gen-cli (Python Edition)
+# ⚡ context-gen-cli (`ctx`) — Python Edition
 
 [![PyPI version](https://img.shields.io/pypi/v/context-gen-cli.svg?color=3775a9)](https://pypi.org/project/context-gen-cli/)
 [![Python Versions](https://img.shields.io/pypi/pyversions/context-gen-cli.svg)](https://pypi.org/project/context-gen-cli/)
@@ -10,13 +10,14 @@
 
 ## 🌟 Highlights
 
-- **100% Accurate Python Dependency Graphs**: Built using Python's native `ast` (Abstract Syntax Tree) module to resolve imports, relative packages, entry points, and utilities without regex guesswork.
+- **⚡ Short Command Alias (`ctx`)**: Type `ctx` anywhere in your terminal.
+- **100% Accurate Python Dependency Graphs**: Built using Python's native `ast` (Abstract Syntax Tree) module to resolve imports, relative packages, entry points, and utilities.
+- **📁 Clean Workspace Storage**: Everything (`agent.md`, `agent.json`, `agent.yaml`, `.context-gen.json`) is saved neatly inside `context/`.
 - **⚡ All-In-One Default Mode (`-d`)**: Auto-generates triple context formats in `context/` and runs a live auto-sync watcher in the background.
 - **`.gitignore` & Multi-Ignore Respect**: Automatically parses rules from `.gitignore`, `.npmignore`, `.dockerignore`, `.contextignore`, `.ignore`, and filters `.env*` secrets.
 - **Triple Format Output**: Generates Markdown (`agent.md`), MCP-compatible structured JSON (`agent.json`), and clean YAML (`agent.yaml`).
 - **🔄 Auto-Sync Watch Mode (`-w`)**: Monitors workspace changes and updates context files automatically on save.
-- **Configuration Parity**: Seamlessly reads `.context-gen.json` if present to maintain unified project settings with the Node.js edition.
-- **Modern CLI**: Styled with `typer` and `rich` for rich terminal output and progress reporting.
+- **Configuration Parity**: Seamlessly reads `context/.context-gen.json` to maintain unified project settings with the Node.js edition.
 
 ---
 
@@ -36,75 +37,52 @@ pip install context-gen-cli
 Generates all formats in `context/` and starts the live auto-sync watcher in background:
 
 ```bash
-context-gen -d
+ctx -d
 ```
 
 ### 2. Generate All Formats (Markdown, JSON, YAML)
 Scans the current directory and outputs `agent.md`, `agent.json`, and `agent.yaml` in `context/`:
 
 ```bash
-context-gen .
+ctx
 ```
 
-### 3. Generate Specific Format (JSON / MD / YAML)
-Generate only the format you need:
-
+### 3. Quick Refresh / Regenerate
 ```bash
-# Generate MCP-ready JSON
-context-gen . --format json
-
-# Generate Markdown
-context-gen . --format md
-
-# Generate YAML
-context-gen . --format yaml
+ctx update
 ```
 
-### 4. Watch Mode
-Keep context files fresh automatically on every file edit:
-
+### 4. Custom Format & Output Destination
 ```bash
-context-gen . --watch
+ctx update -f json
+ctx -o custom_docs/
+ctx -p /path/to/project
 ```
 
-### 5. Custom Output Destination & Directory Depth
+### 5. Watch Mode
+Keep context files fresh automatically on every file edit:
+
 ```bash
-context-gen ./my-project -o custom/docs/context.md --max-depth 4
+ctx -w
 ```
 
 ---
 
 ## 📖 CLI Reference
 
-```text
-Usage: context-gen [OPTIONS] [PATH]
-
-Arguments:
-  [PATH]    Target project directory to analyze  [default: .]
-
-Options:
-  -d, --default             ⚡ Zero-config default mode: generate all formats in context/ and run live auto-sync watcher
-  -f, --format [all|md|json|yaml]  Output format [default: all]
-  -o, --output PATH         Custom output file path (e.g. context/agent.md or custom.json)
-  -w, --watch               Watch directory and auto-regenerate context on file changes
-  --max-depth INTEGER       Maximum directory depth to scan (1-10) [default: 3]
-  --help                    Show this message and exit
-```
-
----
-
-## 🌐 Node.js & Live MCP Server
-
-Looking for the live MCP server with interactive SSE streaming and public tunnels? Check out the [Node.js edition](https://www.npmjs.com/package/context-gen-cli):
-
-```bash
-npx context-gen-cli -d
-# or
-npx context-gen-cli --mcp
-```
+| Flag / Command | Alias | Description |
+| :--- | :--- | :--- |
+| `ctx -d` | `ctx --default` | **⚡ All-in-One**: Generates context files and starts live auto-sync watcher |
+| `ctx -w` | `ctx --watch` | **👀 Watch Mode**: Auto-regenerates context on file changes |
+| `ctx -f <type>` | `ctx --format <type>` | **Format**: `md`, `json`, `yaml`, or `all` |
+| `ctx -o <path>` | `ctx --output <path>` | **Custom Output**: Output file/folder path |
+| `ctx -p <path>` | `ctx --project <path>` | **Target Directory**: Directory to analyze |
+| `ctx update` | — | **Refresh**: Regenerate context files |
+| `ctx --help` | — | View full help options |
 
 ---
 
 ## 📄 License
 
 MIT © [yakkshit](https://github.com/yakkshit)
+

{context_gen_cli-1.2.0 → context_gen_cli-1.2.5}/context_gen/cli.py

@@ -12,6 +12,8 @@ import typer
 from rich.console import Console
 from rich.panel import Panel
 from rich.table import Table
+from rich.progress import Progress, SpinnerColumn, TextColumn, BarColumn, TaskProgressColumn, TimeElapsedColumn
+from rich.text import Text
 
 from context_gen.scanner import scan_project
 from context_gen.extractor import extract_metadata
@@ -50,9 +52,12 @@ def execute_generation(
     metadata = extract_metadata(str(target_dir), files)
     graph = build_dependency_graph(files, str(target_dir))
 
-    # Read output directory from .context-gen.json if available
-    config_file = target_dir / ".context-gen.json"
+    # Read output directory from context/.context-gen.json or legacy .context-gen.json
     output_dir_name = "context"
+    config_file = target_dir / "context" / ".context-gen.json"
+    if not config_file.is_file():
+        config_file = target_dir / ".context-gen.json"
+
     if config_file.is_file():
         try:
             with open(config_file, "r", encoding="utf-8") as f:
@@ -166,7 +171,16 @@ def main(
     path: Path = typer.Argument(
         default=Path("."),
         help="Target project directory to analyze.",
-        exists=True,
+        file_okay=False,
+        dir_okay=True,
+        readable=True,
+        resolve_path=True,
+    ),
+    project: Optional[Path] = typer.Option(
+        None,
+        "--project",
+        "-p",
+        help="Target project directory to analyze.",
         file_okay=False,
         dir_okay=True,
         readable=True,
@@ -185,6 +199,18 @@ def main(
         help="Output format: 'all', 'md', 'json', or 'yaml'.",
         case_sensitive=False,
     ),
+    mcp: bool = typer.Option(
+        False,
+        "--mcp",
+        "-m",
+        help="Start MCP server mode.",
+    ),
+    interactive: bool = typer.Option(
+        False,
+        "--interactive",
+        "-i",
+        help="Run in interactive mode.",
+    ),
     output: Optional[Path] = typer.Option(
         None,
         "--output",
@@ -208,7 +234,190 @@ def main(
     """
     Scan a project, build an AST-powered dependency graph, and generate LLM context.
     """
-    target_dir = path.resolve()
+    target_dir = (project or path).resolve()
+
+    # If -d / --default is supplied, generate all formats and keep watch running
+def print_python_banner():
+    """Renders a stylish ASCII gradient banner in Python CLI."""
+    banner = """
+   ___ _   _  __
+  / __| |_ \ \/ /
+ | (__|  _| >  < 
+  \___|\__|/_/\_\
+"""
+    console.print(f"[bold magenta]{banner}[/bold magenta]")
+    console.print(Panel.fit("[bold cyan]⚡ context-gen-cli (ctx)[/bold cyan] — [magenta]AST AI Project Context Generator[/magenta]", border_style="cyan"))
+    console.print("")
+
+
+def execute_generation_with_progress(
+    target_dir: Path,
+    format_choice: OutputFormat,
+    output_override: Optional[Path] = None,
+    max_depth: int = 3
+) -> dict:
+    """Executes the pipeline with rich progress bar animation."""
+    with Progress(
+        SpinnerColumn("dots", style="cyan"),
+        TextColumn("[bold blue]{task.description}"),
+        BarColumn(bar_width=35, complete_style="magenta", finished_style="green"),
+        TaskProgressColumn(),
+        TimeElapsedColumn(),
+        console=console
+    ) as progress:
+        t1 = progress.add_task("🔍 Scanning workspace files & security ignores...", total=100)
+        scan_result = scan_project(str(target_dir), max_depth=max_depth)
+        time.sleep(0.08)
+        progress.update(t1, completed=100)
+
+        t2 = progress.add_task("📦 Extracting metadata & tech stack signals...", total=100)
+        files = scan_result["files"]
+        tree = scan_result["tree"]
+        metadata = extract_metadata(str(target_dir), files)
+        time.sleep(0.08)
+        progress.update(t2, completed=100)
+
+        t3 = progress.add_task("🕸️  Parsing AST module dependency graph...", total=100)
+        graph = build_dependency_graph(files, str(target_dir))
+        time.sleep(0.08)
+        progress.update(t3, completed=100)
+
+        t4 = progress.add_task(f"✍️  Generating context artifacts ({format_choice.value})...", total=100)
+
+        output_dir_name = "context"
+        config_file = target_dir / "context" / ".context-gen.json"
+        if not config_file.is_file():
+            config_file = target_dir / ".context-gen.json"
+
+        if config_file.is_file():
+            try:
+                with open(config_file, "r", encoding="utf-8") as f:
+                    cfg = json.load(f)
+                    output_dir_name = cfg.get("outputDir", "context")
+            except Exception:
+                pass
+
+        dest_dir = target_dir / output_dir_name
+        dest_dir.mkdir(parents=True, exist_ok=True)
+        generated_files: List[Path] = []
+
+        if output_override:
+            out_file = output_override.resolve()
+            out_file.parent.mkdir(parents=True, exist_ok=True)
+            if format_choice == OutputFormat.JSON:
+                json_data = generate_agent_json(metadata, graph, tree, str(target_dir))
+                out_file.write_text(json.dumps(json_data, indent=2), encoding="utf-8")
+            elif format_choice == OutputFormat.YAML:
+                yaml_text = generate_agent_yaml(metadata, graph, tree, str(target_dir))
+                out_file.write_text(yaml_text, encoding="utf-8")
+            else:
+                md_text = generate_agent_md(metadata, graph, tree)
+                out_file.write_text(md_text, encoding="utf-8")
+            generated_files.append(out_file)
+        else:
+            formats_to_build = ["md", "json", "yaml"] if format_choice == OutputFormat.ALL else [format_choice.value]
+
+            if "md" in formats_to_build:
+                md_file = dest_dir / "agent.md"
+                md_text = generate_agent_md(metadata, graph, tree)
+                md_file.write_text(md_text, encoding="utf-8")
+                generated_files.append(md_file)
+
+            if "json" in formats_to_build:
+                json_file = dest_dir / "agent.json"
+                json_data = generate_agent_json(metadata, graph, tree, str(target_dir))
+                json_file.write_text(json.dumps(json_data, indent=2), encoding="utf-8")
+                generated_files.append(json_file)
+
+            if "yaml" in formats_to_build:
+                yaml_file = dest_dir / "agent.yaml"
+                yaml_text = generate_agent_yaml(metadata, graph, tree, str(target_dir))
+                yaml_file.write_text(yaml_text, encoding="utf-8")
+                generated_files.append(yaml_file)
+
+        time.sleep(0.08)
+        progress.update(t4, completed=100)
+
+    console.print("")
+    return {
+        "files": files,
+        "graph": graph,
+        "metadata": metadata,
+        "generated_files": generated_files,
+        "output_dir": dest_dir
+    }
+
+
+@app.command()
+def main(
+    path: Path = typer.Argument(
+        default=Path("."),
+        help="Target project directory to analyze.",
+        file_okay=False,
+        dir_okay=True,
+        readable=True,
+        resolve_path=True,
+    ),
+    project: Optional[Path] = typer.Option(
+        None,
+        "--project",
+        "-p",
+        help="Target project directory to analyze.",
+        file_okay=False,
+        dir_okay=True,
+        readable=True,
+        resolve_path=True,
+    ),
+    default_mode: bool = typer.Option(
+        False,
+        "--default",
+        "-d",
+        help="⚡ Zero-config default mode: generate all formats in context/ and run live auto-sync watcher.",
+    ),
+    format: OutputFormat = typer.Option(
+        OutputFormat.ALL,
+        "--format",
+        "-f",
+        help="Output format: 'all', 'md', 'json', or 'yaml'.",
+        case_sensitive=False,
+    ),
+    mcp: bool = typer.Option(
+        False,
+        "--mcp",
+        "-m",
+        help="Start MCP server mode.",
+    ),
+    interactive: bool = typer.Option(
+        False,
+        "--interactive",
+        "-i",
+        help="Run in interactive mode.",
+    ),
+    output: Optional[Path] = typer.Option(
+        None,
+        "--output",
+        "-o",
+        help="Custom output file path (e.g. context/agent.md or custom.json).",
+    ),
+    watch: bool = typer.Option(
+        False,
+        "--watch",
+        "-w",
+        help="Watch directory and auto-regenerate context on file changes.",
+    ),
+    max_depth: int = typer.Option(
+        3,
+        "--max-depth",
+        help="Maximum directory depth to scan.",
+        min=1,
+        max=10,
+    ),
+) -> None:
+    """
+    Scan a project, build an AST-powered dependency graph, and generate LLM context.
+    """
+    target_dir = (project or path).resolve()
+    print_python_banner()
 
     # If -d / --default is supplied, generate all formats and keep watch running
     if default_mode:
@@ -220,7 +429,7 @@ def main(
                 border_style="cyan"
             )
         )
-        res = execute_generation(target_dir, OutputFormat.ALL, max_depth=max_depth)
+        res = execute_generation_with_progress(target_dir, OutputFormat.ALL, max_depth=max_depth)
         table = Table(show_header=False, box=None)
         table.add_row("[bold]Scanned Files:[/bold]", f"[cyan]{len(res['files'])}[/cyan]")
         table.add_row("[bold]AST Graph Edges:[/bold]", f"[cyan]{len(res['graph']['edges'])}[/cyan]")
@@ -230,17 +439,7 @@ def main(
         run_watch_loop(target_dir, OutputFormat.ALL, max_depth=max_depth)
         return
 
-    console.print(
-        Panel.fit(
-            f"[bold cyan]⚡ context-gen-cli (Python Edition)[/bold cyan]\n"
-            f"[dim]Analyzing target:[/dim] [green]{target_dir}[/green]\n"
-            f"[dim]Format:[/dim] [yellow]{format.value.upper()}[/yellow]",
-            border_style="cyan"
-        )
-    )
-
-    with console.status("[bold green]Scanning directory and parsing AST graph...[/bold green]"):
-        res = execute_generation(target_dir, format, output_override=output, max_depth=max_depth)
+    res = execute_generation_with_progress(target_dir, format, output_override=output, max_depth=max_depth)
 
     # Display completion summary
     table = Table(show_header=False, box=None)
@@ -258,9 +457,51 @@ def main(
         )
     )
 
+    tips = (
+        "[bold cyan]ctx -w[/bold cyan] (or [cyan]ctx --watch[/cyan])        → Keep context fresh (auto-syncs on save)\n"
+        "[bold cyan]ctx -d[/bold cyan] (or [cyan]ctx --default[/cyan])      → ⚡ All-in-one (generate + live watcher)\n"
+        "[bold cyan]ctx update -f json[/bold cyan]            → Quick format change (md, json, yaml, all)\n"
+        "[bold cyan]ctx -o <dir>[/bold cyan]                  → Custom output folder\n"
+        f"[dim]Config saved in:[/dim] [yellow]{res['output_dir'] / '.context-gen.json'}[/yellow]"
+    )
+    console.print(Panel(tips, title="[bold]💡 Pro-Tips & Next Steps[/bold]", border_style="blue"))
+
     if watch:
         run_watch_loop(target_dir, format, max_depth=max_depth)
 
 
+@app.command()
+def update(
+    path: Path = typer.Argument(
+        default=Path("."),
+        help="Target project directory to analyze.",
+        file_okay=False,
+        dir_okay=True,
+        readable=True,
+        resolve_path=True,
+    ),
+    format: OutputFormat = typer.Option(
+        OutputFormat.ALL,
+        "--format",
+        "-f",
+        help="Output format: 'all', 'md', 'json', or 'yaml'.",
+        case_sensitive=False,
+    ),
+    output: Optional[Path] = typer.Option(
+        None,
+        "--output",
+        "-o",
+        help="Custom output file path.",
+    ),
+) -> None:
+    """
+    Regenerate and update project context files.
+    """
+    target_dir = path.resolve()
+    with console.status("[bold green]Updating project context files...[/bold green]"):
+        res = execute_generation(target_dir, format, output_override=output)
+    console.print(f"[bold green]✓ Context updated in {res['output_dir']}![/bold green]")
+
+
 if __name__ == "__main__":
     app()

context_gen_cli-1.2.5/context_gen/mcp/__init__.py

@@ -0,0 +1,3 @@
+"""
+context_gen.mcp: Model Context Protocol tools and server integrations for context-gen-cli.
+"""