doum-cli 0.1.0

AI-powered terminal assistant that helps you with command-line tasks.
Documentation 
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
104
105
106
107
108
109
110
111
112

# doum-cli

🤖 **AI-Powered Terminal Assistant** - Natural language interface for OS commands

[![Rust](https://img.shields.io/badge/rust-1.70%2B-orange.svg)](https://www.rust-lang.org/)
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)

## Features

- 💬 **Ask Mode**: Get answers to technical questions
- 🔍 **Suggest Mode**: Command suggestions with copy/execute options
- 🎯 **Auto Mode**: LLM automatically selects the appropriate mode
- ⚙️ **Config TUI**: Interactive configuration menu built with ratatui
- 🌍 **Multi-Provider**: Support for OpenAI (GPT) and Anthropic (Claude)

## Quick Start

### Installation

#### Using Installation Script (Recommended)

**Linux / macOS:**
```bash
curl -fsSL https://raw.githubusercontent.com/junhyungL/doum-cli/main/scripts/install.sh | sh
```

**Windows (PowerShell):**
```powershell
iwr -useb https://raw.githubusercontent.com/junhyungL/doum-cli/main/scripts/install.ps1 | iex
```

#### From GitHub Releases

Download the latest binary for your platform from [Releases](https://github.com/junhyungL/doum-cli/releases):

- **Linux (x86_64)**: `doum-linux-x86_64.tar.gz`
- **macOS (Intel)**: `doum-macos-x86_64.tar.gz`
- **macOS (Apple Silicon)**: `doum-macos-aarch64.tar.gz`
- **Windows (x86_64)**: `doum-windows-x86_64.zip`

Extract and add to your PATH.

#### Using Cargo

```bash
cargo install doum-cli
```

### Setup API Key

```bash
doum config
# LLM Settings → Providers → OpenAI → Edit API Key
```

### Usage Examples

```bash
# Ask questions
doum ask "What is Docker?"

# Get command suggestions
doum suggest "find large files"
→ Select option → Choose Copy/Execute

# Auto mode
doum "check disk usage"
```

## Commands

| Command | Description |
|---------|-------------|
| `doum ask <question>` | Ask questions and get answers |
| `doum suggest <task>` | Get command suggestions and execute |
| `doum config` | Manage configuration (TUI) |
| `doum <input>` | Auto mode (LLM selects mode) |

## Documentation

- [Architecture](docs/ARCHITECTURE.md) - Architecture and module structure
- [Commands](docs/COMMANDS.md) - Detailed command reference
- [Quick Start](docs/QUICKSTART.md) - Installation and getting started
- [TODO](docs/TODO.md) - Development roadmap

## Tech Stack

- **Language**: Rust 2024
- **Terminal UI**: dialoguer, ratatui (config TUI)
- **LLM**: OpenAI GPT, Anthropic Claude

## Development

```bash
# Build
cargo build --release

# Run tests
cargo test

# Run
./target/release/doum-cli
```

## License

MIT License - see [LICENSE](LICENSE) for details

## Acknowledgments

- Powered by [OpenAI](https://openai.com/) & [Anthropic](https://www.anthropic.com/)
- Built with [Rust](https://www.rust-lang.org/) 🦀