cli_engineer 1.1.0

An experimental autonomous CLI coding agent
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103

# CLI Engineer

Agentic CLI for software engineering automation. It features pluggable LLM providers, task interpretation, planning, execution, review and an agentic loop.

## Quick Start

### Installation

```bash
cargo install cli_engineer
cli_engineer --help
```

### Basic Usage

CLI Engineer provides specialized commands for different types of software engineering tasks:

```bash
# Code generation
cli_engineer code "create a full-stack task management app with React frontend, Node.js/Express backend, PostgreSQL database, user authentication, and REST API"

# Code review and analysis
cli_engineer review "focus on error handling and performance"

# Documentation generation
cli_engineer docs

# Security analysis
cli_engineer security

# Refactoring assistance
cli_engineer refactor "improve code organization and performance"
```

### UI Options

**Dashboard UI (Default)** - Interactive real-time interface with metrics and progress tracking:
```bash
# Dashboard with live metrics (default behavior)
cli_engineer docs "document the architecture"

# Dashboard + File Logging - logs appear in UI AND saved to file
cli_engineer -v security "analyze code security"
# Creates: cli_engineer_YYYYMMDD_HHMMSS.log with all session details
```

**Simple Text Mode** - Traditional command-line output:
```bash
# Simple text output (disable dashboard)
cli_engineer --no-dashboard docs "document the architecture"

# Simple text + File logging
cli_engineer --no-dashboard -v review "analyze code quality"
```

**Key Features:**
- 🎛️ **Dashboard UI**: Default experience with real-time metrics, progress bars, and live log display
- 📄 **Simple Text**: Clean terminal output for scripts or minimal environments
- 📝 **File Logging**: Verbose mode (`-v`) automatically creates timestamped session logs
- 🔄 **Dual Output**: Dashboard mode with verbose shows logs in UI AND saves to file simultaneously

## Documentation

 **For comprehensive guides and detailed information, see the [docs/](./docs/) directory:**

- **[User Guide](./docs/user-guide.md)** - Complete installation, configuration, and usage instructions
- **[Architecture](./docs/architecture.md)** - Technical architecture and design decisions  
- **[API Reference](./docs/api-reference.md)** - Detailed API documentation
- **[Development Guide](./docs/development.md)** - Contributing and development setup
- **[Documentation Structure](./docs/documentation-structure.md)** - Guide to the documentation organization

## Command Reference

| Command | Purpose | Output |
|---------|---------|--------|
| `code` | Generate new code | Source files in current directory |
| `review` | Analyze existing code | `code_review.md` with findings |
| `docs` | Generate documentation | Documentation files in `docs/` |
| `security` | Security analysis | `security_report.md` with vulnerabilities |
| `refactor` | Code improvement | Refactored source files |

## Developer Setup

```bash
git clone https://github.com/trilogy-group/cli_engineer
cd cli_engineer
cargo build
cargo test
```

## Features

- 🤖 **Multiple LLM Providers**: OpenAI, Anthropic, OpenRouter support
- 📊 **Dashboard UI (Default)**: Real-time metrics and progress tracking 
- 📝 **File Logging**: Automatic session logging with verbose mode (`cli_engineer_YYYYMMDD_HHMMSS.log`)
- 🔄 **Agentic Loop**: Iterative planning, execution, and review
- 📁 **Smart Artifacts**: Context-aware file generation with proper restrictions
- 🔒 **Command-Specific Behavior**: Different file permissions and outputs per command type
- 📖 **Comprehensive Documentation**: Auto-generated docs with examples and API references

---

See the [User Guide](./docs/user-guide.md) for detailed setup and advanced usage instructions.