Skip to content

cli.md

Latest commit

 

History

History
147 lines (104 loc) · 3.44 KB

cli.md

File metadata and controls

147 lines (104 loc) · 3.44 KB

CLI Reference

This document provides a complete reference for all Codomyrmex command-line interface (CLI) commands and options.

📋 Overview

The Codomyrmex CLI provides convenient access to all major functionality through the codomyrmex command. The CLI is organized into logical subcommands for different operations.

Installation Verification

# Check if CLI is properly installed
codomyrmex --version

# Get basic help
codomyrmex --help

🔧 Global Options

All commands accept the following global flags:

--verbose, -v     Enable verbose logging
--performance, -p Enable performance monitoring output where supported

🧭 Command Reference

codomyrmex check

Run environment validation checks.

codomyrmex check

codomyrmex info

Display high-level project information.

codomyrmex info

codomyrmex modules

List available modules and their summaries.

codomyrmex modules

codomyrmex status

Show the system status dashboard. Use the global --performance flag to include performance statistics.

codomyrmex status
codomyrmex --performance status

codomyrmex shell

Launch the interactive Codomyrmex shell.

codomyrmex shell

codomyrmex workflow

Manage orchestration workflows.

codomyrmex workflow list
codomyrmex workflow run <name> [--params JSON] [--async]
codomyrmex workflow create <name> [--template TEMPLATE]
  • list — display registered workflows.
  • run — execute a workflow with optional JSON parameters and asynchronous execution.
  • create — create a workflow, optionally based on an existing template.

codomyrmex project

Work with project definitions.

codomyrmex project list
codomyrmex project create <name> [--template TEMPLATE] [--description TEXT] [--path DIRECTORY]

codomyrmex orchestration

Inspect orchestration engine status.

codomyrmex orchestration status
codomyrmex orchestration health

codomyrmex ai

Access AI-powered helpers.

codomyrmex ai generate <prompt> [--language LANG] [--provider PROVIDER]
codomyrmex ai refactor <file> <instruction>
  • generate — produce code for the supplied prompt, optionally selecting language and provider.
  • refactor — request AI-driven refactoring for the given file and instruction.

codomyrmex analyze

Run analysis tasks.

codomyrmex analyze code <path> [--output DIRECTORY]
codomyrmex analyze git [--repo PATH]
  • code — run code-quality analysis for the specified path, optionally writing reports to --output.
  • git — analyze a repository (defaults to the current directory unless --repo is provided).

codomyrmex build

Execute build automation.

codomyrmex build project [--config FILE]

codomyrmex module

Operate on individual modules.

codomyrmex module test <module_name>
codomyrmex module demo <module_name>
  • test — run the module's tests.
  • demo — execute the module's demo routine when available.

Version: 0.1.0
Last Updated: Aligned with current CLI implementation
Support: See Troubleshooting Guide or GitHub Issues

Navigation Links