@arenis/baduno
Version: 
Professional AI coding assistant CLI - Chat with AI, manage files, generate code, fix bugs automatically
197 lines (140 loc) • 4.28 kB
Markdown
# 🚀 BadunoAI CLI
The most powerful AI assistant for developers - right in your terminal.
## ✨ Features
- 🎨 **Beautiful Terminal UI** - Professional monochrome design with smooth animations
- 🔐 **Secure Authentication** - API key-based authentication with web flow
- 💬 **Interactive Chat** - Real-time conversations with AI
- ⚡ **Live Progress Tracking** - See exactly what the AI is doing in real-time
- ✅ **Visual Feedback** - Green checkmarks for all completed operations
- 🧠 **Smart Thinking** - Live status updates showing AI's thought process (max 15 words)
- 📝 **Automatic File Operations** - Read, write, modify files automatically
- 🔧 **Shell Command Execution** - Run commands with live progress
- 🚀 **No Gaps** - Continuous feedback, never looks frozen
- 🔄 **Auto-Update** - Automatically stays up-to-date with latest features (v1.1.0+)
## 📦 Installation
### Option 1: Using npx (Recommended - Works everywhere!)
```bash
npx @arenis/baduno
```
No installation needed, works immediately!
### Option 2: Global installation
```bash
npm install -g @arenis/baduno
```
Then use:
```bash
baduno
```
**Troubleshooting**: If `baduno` command is not found after global installation:
```bash
# Fix: Add npm global bin to your PATH
echo 'export PATH="$(npm bin -g):$PATH"' >> ~/.bashrc
source ~/.bashrc
# Or just use npx:
npx @arenis/baduno
```
## 🚀 Quick Start
Simply type:
```bash
baduno
```
On first run, you'll be redirected to https://www.baduno.ai/cli-auth to generate your API key.
## 🎯 Usage
### Starting BadunoAI
```bash
baduno
```
That's it! The CLI starts immediately and you can start chatting.
### Slash Commands
```
/help              Show all available commands
/clear             Clear chat history
/history           Show conversation history
/save <file>       Save chat to file
/code <lang>       Generate code in specific language
/file read <path>  Read file content
/file write <path> Write to file
/file edit <path>  Edit file with AI
/model <name>      Change AI model
/status            Show system status
/logout            Logout and clear API key
/exit or /quit     Exit BadunoAI CLI
```
### Examples
```bash
# Start CLI
baduno
# In the CLI:
> What is React?
# Use slash commands
> /help
> /code python Create a web scraper
> /file read app.js
> /save my-chat.md
> /exit
```
## 🎨 Features in Detail
### 🔐 Authentication
- First-time users are redirected to the web interface
- Generate API key on the website
- Paste it into the CLI
- Key is securely stored in `~/.baduno/config.json`
### 💬 Chat Interface
- **Fixed input area** at the bottom
- **Real-time streaming** responses
- **Thinking animation** (spinning indicator, no text)
- **Colored output** with gradient effects
- **Code highlighting** in responses
### 📝 Slash Commands
All commands use `/` prefix (not `--`):
- `/help` - Show help
- `/clear` - Clear history
- `/code` - Generate code
- `/file` - File operations
- `/exit` - Exit CLI
### 🎨 Design
- Beautiful ASCII art banner
- Gradient colors (pink → purple → cyan)
- Animated thinking indicator
- Fixed input prompt
- Professional terminal UI
## ⚙️ Configuration
Configuration is stored in: `~/.baduno/config.json`
```json
{
  "apiKey": "your-api-key-here",
  "createdAt": "2025-10-12T..."
}
```
## 🔧 Development
```bash
# Clone repository
git clone https://github.com/baduno/baduno-cli
# Install dependencies
cd baduno-cli
npm install
# Link for local development
npm link
# Run
baduno
```
## 📝 Requirements
- Node.js >= 16.0.0
- Internet connection
- Terminal with color support
## 🤝 Contributing
Contributions are welcome! Please open an issue or PR.
## 📄 License
MIT License - See LICENSE file for details.
## 💬 Support
- Website: https://www.baduno.ai
- Auth Page: https://www.baduno.ai/cli-auth
- Issues: https://github.com/baduno/baduno-cli/issues
## 🌟 What Makes BadunoAI CLI Special?
- **No complicated flags** - Just type `baduno` and start
- **Beautiful UI** - Not your average boring CLI
- **Smart commands** - Use `/` for everything
- **Real code editing** - Actually edit files with AI
- **Professional design** - Terminal UI that looks amazing
---
Made with ❤️ by BadunoAI Team