Skip to content

Commit b6a11d0

Browse files
committed
Some documentation update
1 parent fa23fc6 commit b6a11d0

3 files changed

Lines changed: 75 additions & 181 deletions

File tree

README.md

Lines changed: 5 additions & 180 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@ Quick overview of current menu shotcuts and key combinations
2626
- **Keyboard Shortcuts**: Efficient keyboard-driven workflow
2727
- **Session Management**: Unsaved changes confirmation on exit
2828
- **Cross-Platform**: Runs on Linux, Windows, and macOS
29+
- **Language Support**: Shell, Bash, Python, Go, Markdown
2930

3031
## Integrated Git Operations
3132

@@ -109,12 +110,6 @@ When the Commit button is selected:
109110
- **Repository Detection**: Automatically detects if current directory is a Git repository
110111
- **Cross-Platform**: Works consistently on Linux, Windows, and macOS
111112

112-
### Keyboard Shortcut
113-
114-
| Shortcut | Action |
115-
|----------|--------|
116-
| `Ctrl+G` | Open/Close Git Operations Panel |
117-
118113
### Technical Details
119114

120115
The Git integration uses:
@@ -163,91 +158,6 @@ Your file is marked as modified but not automatically saved, giving you full con
163158
- `/config` - Edit configuration settings interactively
164159
- `/help` - Display keyboard shortcuts and agent commands
165160

166-
### Usage Examples
167-
168-
#### Basic Fix Request
169-
170-
```
171-
You: fix the syntax error on line 15
172-
```
173-
174-
The AI detects "fix" keyword, reads your file, identifies the syntax error, and applies the correction.
175-
176-
#### Using /fix Command
177-
178-
```
179-
You: /fix add error handling to the main function
180-
```
181-
182-
Explicitly requests agentic mode. The AI adds error handling code to your main function.
183-
184-
#### Using /ask Command
185-
186-
```
187-
You: /ask how does this function work?
188-
```
189-
190-
Explicitly requests conversational mode. The AI explains the function without modifying code.
191-
192-
#### Using /preview Command
193-
194-
```
195-
You: /preview refactor this to use a switch statement
196-
```
197-
198-
The AI shows you what changes it would make before applying them. You can then approve or request modifications.
199-
200-
#### Using /model Command
201-
202-
```
203-
You: /model
204-
```
205-
206-
The AI displays the current agent (ollama or gemini) and model being used (e.g., llama2, gemini-2.5-flash-lite). If using Gemini, it also displays the API key from the configuration.
207-
208-
#### Using /config Command
209-
210-
```
211-
You: /config
212-
```
213-
214-
Opens an interactive configuration editor where you can modify settings without leaving the application:
215-
- Navigate fields with Up/Down or K/J keys
216-
- Press Enter to edit a field value
217-
- Press Enter again to save the edited value
218-
- Press Esc to save all changes and exit config mode
219-
220-
The configuration is saved to `~/.ti/config.json` and applied immediately without restarting the application.
221-
222-
#### Using /help Command
223-
224-
```
225-
You: /help
226-
```
227-
228-
The AI displays a comprehensive help message including:
229-
- All keyboard shortcuts (same as Ctrl+H)
230-
- Agent commands (/fix, /ask, /preview, /model, /config, /help)
231-
- Fix keywords (fix, change, update, modify, correct) with descriptions
232-
233-
You can also press Ctrl+H at any time to see the help dialog with all keyboard shortcuts and agent commands organized by category.
234-
235-
#### Multiple Changes
236-
237-
```
238-
You: update the function to handle edge cases and add comments
239-
```
240-
241-
The AI applies multiple changes in a single operation: adds edge case handling and documentation comments.
242-
243-
### What Gets Modified
244-
245-
- The AI only modifies the currently open file in the editor
246-
- Changes are applied immediately and visible in the editor
247-
- The file is marked as modified (indicated in the UI)
248-
- You must save manually with `Ctrl+S` to persist changes
249-
- You can undo changes using standard editor undo mechanisms
250-
251161
### Best Practices
252162

253163
1. **Be Specific**: Clearly describe what you want to change
@@ -276,18 +186,12 @@ The AI handles errors gracefully:
276186
### Supported File Types
277187

278188
Agentic code fixing works with:
279-
- Bash scripts (`.sh`, `.bash`)
280-
- Shell scripts (`.sh`)
189+
- Shell scripts (`.sh`, `.bash`)
281190
- PowerShell scripts (`.ps1`)
282191
- Python scripts (`.py`)
283192
- Go source files (`.go`)
284193
- Markdown documents (`.md`)
285194

286-
## Requirements
287-
288-
- Go 1.21 or higher
289-
- Ollama (optional, for AI features)
290-
291195
## Installation
292196

293197
### From Source
@@ -297,15 +201,6 @@ Agentic code fixing works with:
297201
git clone https://github.com/user/terminal-intelligence.git
298202
cd terminal-intelligence
299203

300-
# Build the application
301-
make linux
302-
```
303-
304-
### Compile in windows
305-
```powershell
306-
.\build.ps1 windows
307-
```
308-
309204
### Pre-built Binaries
310205

311206
Download pre-built binaries for your platform from the releases page.
@@ -337,7 +232,7 @@ You can edit this file to customize your settings. The application will load it
337232
```json
338233
{
339234
"agent": "gemini",
340-
"model": "gemini-3-flash-lite",
235+
"model": "gemini-3.1-flash-lite",
341236
"ollama_url": "",
342237
"gemini_api": "your-api-key-here",
343238
"workspace": "/home/user/project-workspace"
@@ -390,81 +285,11 @@ make windows # Build for Windows
390285
make darwin # Build for macOS
391286
```
392287

393-
This generates a coverage report in `coverage.html`.
394-
395-
## Architecture
396-
397-
The application follows a clean architecture with clear separation of concerns:
398-
399-
- **UI Layer**: Bubble Tea components for terminal interface
400-
- **Business Logic**: File management, command execution, AI communication
401-
- **Data Layer**: File system operations
402-
403-
### Key Components
404-
405-
- **App**: Main Bubble Tea application orchestrating all components
406-
- **EditorPane**: Code editor with syntax highlighting and file editing
407-
- **AIChatPane**: AI interaction pane with conversation history
408-
- **FileManager**: Handles all file system operations
409-
- **CommandExecutor**: Executes system commands and scripts
410-
- **OllamaClient**: Communicates with Ollama service via REST API
411-
412-
## Configuration
413-
414-
The application can be configured via:
415-
416-
1. **Configuration file** at `~/.ti/config.json` (loaded automatically if present)
417-
2. **Command-line flags** (override config file values)
418-
3. **Default configuration** (used when no config file or flags provided)
419-
420-
### Configuration Priority
421-
422-
Command-line flags > Config file > Built-in defaults
423-
424-
### Default Configuration
425-
426-
- **Workspace Directory**: `~/ti-workspace`
427-
- **Ollama URL**: `http://localhost:11434`
428-
- **Default Model**: `llama2`
429-
- **Tab Size**: 4 spaces
430-
- **Auto Save**: Disabled
431-
432-
## Cross-Platform Support
433-
434-
The application is designed to run on:
435-
- **Linux**: Tested on Ubuntu 20.04+
436-
- **Windows**: Tested on Windows 10+
437-
- **macOS**: Tested on macOS 11+ (Intel and Apple Silicon)
438-
439-
## Development
440-
441-
### Prerequisites
442-
443-
- Go 1.21 or higher
444-
- Make (for build automation)
445-
- golangci-lint (optional, for linting)
446-
447-
### Development Commands
448-
449-
```bash
450-
make fmt # Format code
451-
make lint # Run linter
452-
make run # Build and run
453-
make clean # Clean build artifacts
454-
```
455-
456-
## Contributing
457-
458-
Contributions are welcome! Please ensure:
459-
460-
1. All tests pass (`make test`)
461-
2. Code is formatted (`make fmt`)
462-
3. Linter passes (`make lint`)
463-
4. New features include tests
288+
- [TI Architecture](./docs/ARCHITECTURE.md) - Overal Architectore overview of Terminal Intelligence (TI)
464289

465290
## License
466291

467-
TBD
292+
MIT
468293

469294
## Acknowledgments
470295

docs/ARCHITECTURE.md

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
## Architecture
2+
3+
The application follows a clean architecture with clear separation of concerns:
4+
5+
- **UI Layer**: Bubble Tea components for terminal interface
6+
- **Business Logic**: File management, command execution, AI communication
7+
- **Data Layer**: File system operations
8+
9+
### Key Components
10+
11+
- **App**: Main Bubble Tea application orchestrating all components
12+
- **EditorPane**: Code editor with syntax highlighting and file editing
13+
- **AIChatPane**: AI interaction pane with conversation history
14+
- **FileManager**: Handles all file system operations
15+
- **CommandExecutor**: Executes system commands and scripts
16+
- **OllamaClient**: Communicates with Ollama service via REST API
17+
18+
## Configuration
19+
20+
The application can be configured via:
21+
22+
1. **Configuration file** at `~/.ti/config.json` (loaded automatically if present)
23+
2. **Command-line flags** (override config file values)
24+
3. **Default configuration** (used when no config file or flags provided)
25+
26+
### Configuration Priority
27+
28+
Command-line flags > Config file > Built-in defaults
29+
30+
### Default Configuration
31+
32+
- **Workspace Directory**: `~/ti-workspace`
33+
- **Ollama URL**: `http://localhost:11434`
34+
- **Default Model**: `llama2`
35+
- **Tab Size**: 4 spaces
36+
- **Auto Save**: Disabled
37+
38+
## Cross-Platform Support
39+
40+
The application is designed to run on:
41+
- **Linux**: Tested on Ubuntu 20.04+
42+
- **Windows**: Tested on Windows 10+
43+
- **macOS**: Tested on macOS 11+ (Intel and Apple Silicon)
44+
45+
## Development
46+
47+
### Prerequisites
48+
49+
- Go 1.21 or higher
50+
- Make (for build automation)
51+
- golangci-lint (optional, for linting)
52+
53+
### Development Commands
54+
55+
```bash
56+
make fmt # Format code
57+
make lint # Run linter
58+
make run # Build and run
59+
make clean # Clean build artifacts
60+
```
61+
62+
## Contributing
63+
64+
Contributions are welcome! Please ensure:
65+
66+
1. All tests pass (`make test`)
67+
2. Code is formatted (`make fmt`)
68+
3. Linter passes (`make lint`)
69+
4. New features include tests

main.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ import (
1111
"github.com/user/terminal-intelligence/internal/ui"
1212
)
1313

14-
var version = "0.0.1.0"
14+
var version = "0.0.2.3"
1515

1616
// Build number (injected at compile time via -ldflags)
1717
var buildNumber = "dev"

0 commit comments

Comments
 (0)