Skip to content

SPEC.md

Latest commit

 

History

History
82 lines (61 loc) · 2.44 KB

SPEC.md

File metadata and controls

82 lines (61 loc) · 2.44 KB

cli - Functional Specification

Version: v1.2.3 | Status: Active | Last Updated: March 2026

Purpose

Command-line interface providing unified access to all Codomyrmex modules and workflows through the codomyrmex command.

Design Principles

Modularity

  • Commands organized by domain (workflow, project, ai, analyze, build, fpf, skills)
  • Handler implementations in separate files for maintainability
  • Composable command structure with subparsers

Functionality

  • Supports both synchronous and asynchronous operations
  • Performance monitoring integration (--performance flag)
  • Verbose output mode (--verbose flag)

Documentation

  • Built-in help for all commands and subcommands
  • Usage examples in epilog
  • Clear error messages for invalid usage

Architecture

graph TD
    CLI[codomyrmex CLI] --> Core[core.py - ArgumentParser]
    Core --> Handlers[handlers/]
    Handlers --> AI[ai.py]
    Handlers --> Analysis[analysis.py]
    Handlers --> Build[build.py]
    Handlers --> Environment[environment.py]
    Handlers --> FPF[fpf.py]
    Handlers --> Skills[skills.py]
    
    AI --> agents[agents module]
    Analysis --> static_analysis[static_analysis module]
    Build --> deployment[deployment module]
    FPF --> fpf_module[fpf module]
    Skills --> skills_module[skills module]
Loading

Command Groups

Command Subcommands Purpose
check - Validate environment setup
info - Show project information
modules - List available modules
status - Show system status dashboard
shell - Launch interactive shell
workflow list, create, run Workflow management
project list, create Project management
orchestration status, health Orchestration system
ai generate, refactor AI-powered operations
analyze code, git Code analysis
build project Build operations
fpf fetch, parse, export, search, visualize, context, analyze, report FPF operations
skills sync, list, get, search Skills management

Navigation

Dependencies

See src/codomyrmex/cli/__init__.py for import dependencies.

Testing

uv run python -m pytest src/codomyrmex/tests/ -k cli -v