centaurus-cli 2.5.3 → 2.6.1

package/CONFIG_GUIDE.md

@@ -1,249 +0,0 @@
-# Centaurus CLI Configuration Guide
-
-## Overview
-
-The Centaurus CLI stores configuration in two places:
-1. **Environment variables** (`.env` file) - Backend API URL (required)
-2. **User config file** (`~/.centaurus/config.json`) - Model preferences and settings
-
-**Important:** API keys are no longer stored in the CLI. All AI model access is managed by the backend service for security and centralized control.
-
-## Initial Setup
-
-### 1. Backend API Configuration (Required)
-
-Create or update `.env` file in the CLI directory:
-
-```env
-BACKEND_API_URL=http://localhost:3000/api
-```
-
-For production, update to your backend URL:
-```env
-BACKEND_API_URL=https://api.yourapp.com/api
-```
-
-**Important:** The backend URL is required for all AI features. The CLI cannot function without a connection to the backend service.
-
-### 2. Authentication (Required)
-
-When you first run the CLI, you'll be prompted to sign in with Google:
-
-1. Start Centaurus: `centaurus`
-2. Choose "Yes" when prompted to sign in
-3. Complete the authentication flow in your browser
-4. Return to the CLI and start chatting!
-
-**Why Authentication?**
-- Secures access to AI models
-- Enables conversation history sync
-- Prevents unauthorized usage
-- No local API key management needed
-
-## Configuration Commands
-
-### View Current Configuration
-
-```bash
-/config
-```
-
-Shows:
-- Current model
-- Theme settings
-- Auto-accept preferences
-- Plan mode status
-
-### Change Model
-
-```bash
-/model
-```
-
-Opens a picker to select from available Google Gemini models:
-- **gemini-2.5-flash** - Fast and efficient (recommended)
-- **gemini-2.5-pro** - Most capable, slower
-- **gemini-2.0-flash-exp** - Experimental features
-- **gemini-1.5-pro** - Previous generation, high quality
-- **gemini-1.5-flash** - Previous generation, fast
-
-Or set directly:
-```bash
-/model gemini-2.5-flash
-```
-
-Your model preference is saved and persists across sessions.
-
-## Authentication
-
-### Sign In (Required)
-
-Authentication is required to use Centaurus CLI. When you first run the CLI, you'll be prompted to sign in with Google:
-
-**What You Get:**
-- ✅ Secure access to AI models
-- ✅ Conversation history across devices
-- ✅ Settings synchronization
-- ✅ Web search capabilities
-- ✅ No local API key management
-
-### Sign Out
-
-```bash
-/logout
-```
-
-Clears your session and exits the CLI. You'll need to sign in again the next time you start the CLI.
-
-## Configuration File Location
-
-Your configuration is stored at:
-- **Windows**: `C:\Users\YourName\.centaurus\config.json`
-- **macOS/Linux**: `~/.centaurus/config.json`
-
-### Config File Structure
-
-```json
-{
-  "model": "gemini-2.5-flash",
-  "theme": "default",
-  "autoAccept": false,
-  "planMode": false
-}
-```
-
-**Note:** API keys are no longer stored in the CLI configuration. They are managed by the backend service.
-
-## Web Search
-
-Web search is handled by the backend and requires:
-1. Authentication (sign in with Google)
-2. Backend server running with Serper API key configured
-
-**No client-side configuration needed!**
-
-The backend administrator manages the Serper API key server-side.
-
-## Troubleshooting
-
-### "Authentication required"
-
-All AI features require authentication. To sign in:
-1. Restart the CLI
-2. Choose "Yes" when prompted to sign in
-3. Complete the Google OAuth flow in your browser
-4. Return to the CLI
-
-### "Backend API is not reachable"
-
-This error means the CLI cannot connect to the backend service.
-
-**Check your `.env` file:**
-```env
-BACKEND_API_URL=http://localhost:3000/api
-```
-
-**Verify backend is running:**
-```bash
-cd backend
-npm start
-```
-
-**Common causes:**
-- Backend service is not running
-- Incorrect backend URL in `.env`
-- Network connectivity issues
-- Firewall blocking the connection
-- Backend is deployed but not accessible from your network
-
-**For production deployments:**
-Ensure the backend URL points to your deployed backend:
-```env
-BACKEND_API_URL=https://api.yourapp.com/api
-```
-
-### "Rate limit exceeded"
-
-The backend has exhausted its API quota with Google. This is managed by the backend administrator.
-
-**What to do:**
-- Wait a few moments and try again
-- Contact your backend administrator if the issue persists
-- The backend may need additional API keys configured for rotation
-
-### "Invalid model"
-
-The model you selected is not supported by the backend.
-
-**Solution:**
-```bash
-/model
-```
-
-Select a valid Google Gemini model from the list.
-
-### Reset Configuration
-
-To start fresh, delete the config file:
-
-**Windows:**
-```cmd
-del %USERPROFILE%\.centaurus\config.json
-```
-
-**macOS/Linux:**
-```bash
-rm ~/.centaurus/config.json
-```
-
-Then restart the CLI. You'll need to sign in again and reconfigure your preferences.
-
-## Security Best Practices
-
-1. **Never commit `.env` files** - Add to `.gitignore`
-2. **Use environment-specific URLs** - Different URLs for dev/prod
-3. **Sign out on shared machines** - Use `/logout` command
-4. **Keep your session secure** - Don't share authentication tokens
-5. **Backend security** - API keys are managed server-side for enhanced security
-
-## Advanced Configuration
-
-### Custom Backend URL
-
-For development or self-hosted backends:
-
-```env
-BACKEND_API_URL=http://localhost:3000/api
-```
-
-For production:
-
-```env
-BACKEND_API_URL=https://api.centaurus.app/api
-```
-
-**Backend Requirements:**
-- Must be configured with Google API keys (managed by backend admin)
-- Must support the `/api/ai/chat` endpoint for streaming
-- Must handle authentication and session management
-- Should implement API key rotation for rate limit handling
-
-## Getting Help
-
-```bash
-/help
-```
-
-Shows all available commands and their usage.
-
-## Next Steps
-
-1. Ensure backend is running and accessible
-2. Configure backend URL in `.env`
-3. Sign in with Google (required)
-4. Choose your preferred model
-5. Start chatting with the AI!
-
-For more information, see:
-- [README.md](./README.md) - General CLI documentation
-- [MIGRATION.md](./MIGRATION.md) - Upgrading from previous versions