AGENTS.md@src/gnn/cli · diff
git:20260924.b1d515d to git:20260925.2efe63d
7 added, 1 removed. Audit A to A.
# CLI Module — Agent Scaffolding
## Module Overview
**Purpose**: Command-line interface and dispatch functionality for the GNN pipeline.
**Pipeline Step**: Infrastructure module (not a numbered step)
**Category**: Infrastructure / Development Tools
**Status**: ✅ Production Ready
**Version**: [pyproject.toml](../../../pyproject.toml) (canonical)
**Last Updated**: 2026-09-24
The CLI module provides the `gnn` command-line tool — a unified interface to the entire GNN pipeline. It acts as a thin dispatcher, routing 18 subcommands to their respective module APIs. Public exits are `0` for success, `1` for errors, and `2` for completed commands with warnings or degraded readiness.
## Architecture
- **Pattern**: Thin dispatcher (not a pipeline step)
- **Entry point**: `gnn.cli:main` (registered in `pyproject.toml [project.scripts]`)
- **Dependencies**: All pipeline modules (imported lazily per subcommand)
## Capabilities
- **Pipeline execution** via `gnn run` with skip/only-steps, log-format, and skip-llm options
- **File validation** via `gnn validate` (section, state-space, connection, dimension checks)
- **JSON/YAML parsing** via `gnn parse` with format and summary modes
- **Code generation** via `gnn render` (PyMDP, RxInfer, ActiveInference.jl, JAX, NumPyro, Stan, PyTorch, DisCoPy, bnlearn)
- **POMDP extraction** via `gnn extract` (structured JSON of the POMDP state space, with graceful degradation when the extractor is unavailable)
- **Run reproduction** via `gnn reproduce` using content-addressable hashing
- **Environment checks** via `gnn preflight` and `gnn health`
- **Live development** via `gnn watch` (file monitoring with 250ms debounce)
- **Dependency graphs** via `gnn graph` (Mermaid/text output)
- **API server** via `gnn serve --surface` (`runs` → `api/app.py`, `jobs` → `api/server.py`, `both` starts the jobs surface on port+1 in a daemon thread)
- **MCP surface inspection** via `gnn mcp list` / `gnn mcp info <tool>` (lazy `gnn.mcp` registry bridge; `--json` emits the standard envelope)
- **LSP server** via `gnn lsp` (canonical `gnn.lsp` pygls server when pygls is importable; `cli/lsp.py` JSON-RPC fallback)
## File Structure
```
cli/
- ├── __init__.py # Main dispatcher and 18 subcommands
+ ├── __init__.py # Package surface: dispatch table, main(), re-exports
├── __main__.py # `python -m gnn.cli` entry point
├── commands.py # Shared command semantics (dispatcher + API parity)
├── lsp.py # GNN Language Server (stdio)
├── mcp.py # MCP tool surface for CLI subcommands
├── templates.py # Maintained template index and copy helpers
+ ├── parser.py # build_parser + argparse type validators
+ ├── helpers.py # Shared envelope/emit/guard/logging helpers + exit codes
+ ├── handlers_pipeline.py # run/validate/parse/extract/render/graph handlers
+ ├── handlers_ops.py # report/reproduce/preflight/health handlers
+ ├── handlers_service.py # serve/watch/lsp/gui/mcp handlers
+ ├── handlers_library.py # templates/models/pull handlers
├── template_index.json # Externalized template metadata
├── template_assets/ # Packaged GNN template files
├── AGENTS.md # This file
├── README.md # Usage guide
├── SPEC.md # Module specification
└── SKILL.md # Capability API
```
## References
- [README.md](README.md) — Usage guide with examples
- [SPEC.md](SPEC.md) — Specification
---
## Documentation
- **[README](README.md)**: Module Overview
- **[AGENTS](AGENTS.md)**: Agentic Workflows
- **[SPEC](SPEC.md)**: Architectural Specification
- **[SKILL](SKILL.md)**: Capability API