architect-cli

Architect CLI

A command-line interface for interacting with the Architect Engine, enabling project management and task execution.

Overview

The Architect CLI is a Kotlin-based command-line tool built with Micronaut and PicoCLI. It provides an intuitive interface for:

• Registering projects with the Architect Engine
• Executing tasks within projects
• Managing the Architect Engine lifecycle
• Monitoring task execution with real-time feedback

Architecture

The CLI consists of several key components:

Core Components

• ArchitectLauncher: Main entry point and command parser
• ConsoleUI: Terminal user interface with rich formatting and progress tracking
• TerminalUI: Low-level terminal rendering utilities
• EngineCommandClient: HTTP client for communicating with the Architect Engine

Data Transfer Objects (DTOs)

• ProjectDTO: Represents a project registered with the engine
• TaskDTO: Represents an executable task
• RegisterProjectRequest: Request payload for project registration
• TaskResultDTO: Hierarchical task execution results
• ExecutionTaskEvent: Events emitted during task execution

Features

Project Management

# Register and list tasks for current project
architect

# Execute a specific task
architect <task-name> [args...]

Engine Management

# Install the Architect Engine
architect engine install

# Install the Architect Engine for CI environments
architect engine install-ci

# Start the engine
architect engine start

# Stop the engine
architect engine stop

# Clean engine data
architect engine clean

Output Modes

• Interactive Mode: Rich terminal UI with progress tracking (default)
• Plain Mode: Simple output for CI environments (use -p or --plain)

# Run in plain mode
architect --plain <task-name>

Building

cd cli
./gradlew build

Running

cd cli
./gradlew run --args="<command>"

Configuration

The CLI requires the Architect Engine to be running and accessible. By default, it connects to:

• URL: Configured via Micronaut's HTTP client settings
• Expected endpoint: /api on the engine server

Technical Stack

• Language: Kotlin 1.9.25
• JVM: Java 17
• Framework: Micronaut 4.6.1
• CLI Framework: PicoCLI
• Build Tool: Gradle 8.14.3
• Serialization: Micronaut Serde (Jackson)
• Async: Kotlin Coroutines

Development

Adding New Commands

1. Add command parameters to ArchitectLauncher
2. Implement command logic in the run() method
3. Update handleEngineCommand() for engine-specific commands

Customizing the UI

• Modify ConsoleUI for terminal UI behavior
• Adjust TerminalUI for rendering utilities
• Update AnsiColors for color scheme changes

Dependencies

• Micronaut Kotlin Runtime
• PicoCLI for command-line parsing
• Kotlin Coroutines for async operations
• Jackson for JSON serialization
• Logback for logging