rust_tui_coder
| Crates.io | rust_tui_coder |
| lib.rs | rust_tui_coder |
| version | 1.0.0 |
| created_at | 2025-11-25 19:47:15.973503+00 |
| updated_at | 2025-11-26 23:27:58.246028+00 |
| description | AI-powered terminal coding assistant with interactive TUI, supporting multiple LLMs and comprehensive development tools |
| homepage | https://github.com/Ammar-Alnagar/Rust-Coder-CLI |
| repository | https://github.com/Ammar-Alnagar/Rust-Coder-CLI |
| max_upload_size | |
| id | 1950354 |
| size | 470,151 |
Ammar (Ammar-Alnagar)
documentation
https://docs.rs/rust_tui_coder
README
Rust TUI Coder
** Documentation has been reorganized into the
docs/folder for better organization.**
Quick Links
Documentation
- Complete README - Full project documentation
- Documentation Index - Navigation guide for all docs
- Getting Started Guide - Installation and setup
- Examples - Practical usage examples
- Troubleshooting - Fix common issues
👨💻 For Developers
- Architecture - System design and structure
- API Reference - Complete API documentation
- Contributing - Contribution guidelines
- Testing - Test suite documentation
📦 For Maintainers
- Publishing Guide - Publishing to crates.io
- Improvements Summary - Recent changes
- Completion Report - Development milestones
Quick Start
Installation
cargo install rust_tui_coder
Configuration
Create a config.toml file:
[llm]
api_key = "your-api-key-here"
api_base_url = "https://api.openai.com/v1"
model_name = "gpt-4"
Run
rct
What is Rust TUI Coder?
A powerful terminal-based AI coding assistant that brings AI intelligence directly to your command line. Built with Rust for performance and reliability.
Key Features
- Natural Language Interface - Chat with AI about your code
- Direct Tool Execution - AI manipulates files and runs commands
- Real-time Monitoring - Watch tool execution in real-time
- Beautiful TUI - Modern terminal interface with ratatui
- Multiple LLM Support - OpenAI, Anthropic, or local models
- Fast & Efficient - Built with Rust for performance
Quick Example
You: Create a Python script that calculates fibonacci numbers and run it
AI: I'll create the script and execute it...
[Creates fibonacci.py]
[Executes the script]
[Shows output: 0, 1, 1, 2, 3, 5, 8, 13, 21, 34...]
Available Tools
- File Operations: read, write, append, search/replace, delete
- Directory Operations: create, list, recursive list
- Code Execution: Python, Bash, Node.js, Ruby
- Plan Management: create plans, update steps, clear plans
- Git Operations: status checking
Documentation Structure
The documentation is organized in the docs/ folder:
docs/
├── README_FULL.md # Complete project README
├── INDEX.md # Documentation navigation
├── GETTING_STARTED.md # Setup and first steps
├── EXAMPLES.md # 30+ usage examples
├── ARCHITECTURE.md # System design
├── API.md # Complete API reference
├── CONTRIBUTING.md # How to contribute
├── TESTING.md # Test suite (94 tests)
├── TROUBLESHOOTING.md # Common issues and fixes
├── PUBLISH.md # Publishing guide
├── IMPROVEMENTS_SUMMARY.md # Recent improvements
└── COMPLETION_REPORT.md # Development report
Start here: Documentation Index
Contributing
We welcome contributions! See CONTRIBUTING.md for guidelines.
License
Licensed under either of:
- Apache License, Version 2.0 (LICENSE or http://www.apache.org/licenses/LICENSE-2.0)
- MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)
at your option.
🔗 Resources
- Full Documentation - Complete documentation guide
- Getting Started - New user guide
- Examples - Real-world usage examples
**Happy Coding! **