Rawi Logo
# ๐Ÿค– Rawi (ุฑุงูˆูŠ) **The AI-Powered CLI That Transforms Your Terminal Into an Intelligent Workspace**
GitHub Repository GitHub Release NPM Version MIT License GitHub Stars NPM Downloads
[๐ŸŒ Website](https://rawi.mkabumattar.com) โ€ข [๐Ÿ“š Documentation](https://rawi.mkabumattar.com/userguide) โ€ข [๐Ÿš€ Quick Start](#-quick-start) โ€ข [๐Ÿ’ฌ Support](https://github.com/withrawi/rawi/issues)
--- **Rawi (ุฑุงูˆูŠ)** is the developer-friendly AI CLI that brings the power of 11 major AI providers directly to your terminal. With seamless shell integration, persistent conversations, and 200+ specialized prompt templates, Rawi transforms your command line into an intelligent development workspace. > _"ุฑุงูˆูŠ" means "storyteller" in Arabic โ€” every great story starts with a question._ ## โœจ Why Choose Rawi? Rawi isn't just another AI CLI tool โ€” it's your complete AI-powered development environment: ๐Ÿ”ฅ **11 AI Providers** โ€” OpenAI, Anthropic, Google, DeepSeek, Ollama, LM Studio, Azure, Bedrock, Mistral, Cerebras, and xAI ๐Ÿ›ก๏ธ **Privacy First** โ€” Local AI support with Ollama and LM Studio โ€” no data leaves your machine โšก **Developer Optimized** โ€” Built specifically for coding workflows and technical tasks ๐Ÿ”„ **Shell Integration** โ€” Perfect pipes, redirects, script automation, and smart completion ๐Ÿ“Š **Smart Sessions** โ€” Persistent conversations with context awareness ๐ŸŽฏ **200+ Templates** โ€” Expert-level prompt templates for specialized responses ๐ŸŒ **Multilingual** โ€” Full support for English and Arabic (ุฑุงูˆูŠ) ๐Ÿ“š **Rich History** โ€” Search, export, and manage your AI conversations ๐Ÿ”ง **Profile Management** โ€” Multiple configurations for different projects ## ๐Ÿš€ Quick Start Get your AI-powered terminal companion running in under 30 seconds: ```bash # Install globally via npm npm install -g rawi # One-command setup (interactive) rawi configure # Start asking questions immediately rawi ask "What's the difference between TypeScript and JavaScript?" ``` ### ๐ŸŽฏ See Rawi in Action ```bash # ๐Ÿ’ก Quick coding help rawi ask "Create a React component for file upload with drag-and-drop" # ๐Ÿ› Debug errors instantly rawi ask "Fix this Python error: NameError: name 'x' is not defined" # ๐ŸŽญ Get specialized AI personas rawi ask --act security-expert "Analyze this authentication code for vulnerabilities" # ๐Ÿ’ฌ Smart session management rawi ask "How do I handle state management?" --new-session rawi ask "What about Redux specifically?" --session abc123 rawi chat --session-name "React Learning" --list-sessions # ๐Ÿ”ง Integrate with your workflow git diff | rawi ask "Review these changes for potential issues" cat server.js | rawi ask --act code-reviewer "Optimize this Express.js code" # ๐Ÿ“Š Session organization and insights rawi history ask --limit 10 # View ask sessions rawi history chat --search "debugging" # Search chat sessions rawi history exec --search "system" # Search exec sessions rawi history ask --all-profiles --provider openai # Filter ask sessions by provider ``` ## ๐Ÿค– AI Providers โ€” Your Choice, Your Control Access the best AI models through one unified interface: | Provider | Top Models | API Key | Local | Best For | | ---------------- | ------------------------------------- | ------- | ----- | ------------------------------ | | **๐Ÿ”ต OpenAI** | GPT-4o, GPT-4, O1, O3, GPT-4o-mini | โœ… | โŒ | General development, coding | | **๐ŸŸฃ Anthropic** | Claude 3.5 Sonnet, Claude 3.5 Haiku | โœ… | โŒ | Analysis, safety, long content | | **๐Ÿ”ด Google** | Gemini 2.0 Flash, Gemini 1.5 Pro | โœ… | โŒ | Fast inference, multimodal | | **๏ฟฝ DeepSeek** | DeepSeek-Chat, DeepSeek-Reasoner | โœ… | โŒ | Cost-effective, reasoning | | **๏ฟฝ๐ŸŸข Ollama** | Llama 3.2, CodeLlama, Qwen, +100 more | โŒ | โœ… | Privacy, offline, free | | **๐Ÿ”ง LM Studio** | Llama 3.3, Phi-4, Gemma-3, Qwen-3 | โŒ | โœ… | Local models, GUI management | | **๐ŸŸ  Mistral** | Mistral Large, Mistral Small, Pixtral | โœ… | โŒ | European AI, multilingual | | **โšก Cerebras** | Llama 3.3 70B, Llama 3.1 70B/8B | โœ… | โŒ | Ultra-fast inference, speed | | **๐Ÿ”ท Azure** | Enterprise OpenAI deployments | โœ… | โŒ | Enterprise, compliance | | **๐ŸŸ  Bedrock** | Claude, Llama, Titan via AWS | โœ… | โŒ | AWS integration, scale | | **๐Ÿค– xAI** | Grok-3, Grok-2, Grok-Beta | โœ… | โŒ | Real-time, conversational | > **๐Ÿ›ก๏ธ Privacy Focused**: Use Ollama or LM Studio for complete privacy โ€” all processing happens locally on your machine. ## ๐ŸŽฏ Act Templates โ€” 200+ Specialized AI Personas Transform your prompts with expertly crafted AI personas for specialized responses. Templates work globally across all profiles: ```bash # ๐Ÿ” Browse all available templates rawi act --list # ๐Ÿ“– Get detailed template information rawi act --show ethereum-developer # โž• Create your own custom templates rawi act --create # โœ๏ธ Edit existing custom templates rawi act --edit my-template # ๐Ÿ—‘๏ธ Remove custom templates rawi act --delete my-template # ๐Ÿš€ Use templates in conversations (works with any profile) rawi ask --act linux-terminal "list files in home directory with details" rawi ask --act code-reviewer "analyze this Python function for improvements" rawi ask --act security-expert "audit this authentication implementation" ``` ### ๐Ÿ”ฅ Popular Templates by Category **๐Ÿ› ๏ธ Development** - `ethereum-developer` โ€” Smart contract development & security - `linux-terminal` โ€” Terminal command simulation - `code-reviewer` โ€” Code analysis and optimization **๐Ÿ”’ Security** - `security-expert` โ€” Security analysis and auditing - `penetration-tester` โ€” Security testing and vulnerability assessment **๐Ÿ“ Documentation** - `tech-writer` โ€” Technical documentation - `api-documenter` โ€” API documentation and examples **๐Ÿ—„๏ธ Database** - `database-admin` โ€” SQL optimization and database management - `data-analyst` โ€” Data analysis and insights **๐ŸŽจ Creative** - `ux-designer` โ€” User experience and interface design - `marketing-expert` โ€” Marketing copy and strategy Use `rawi act --list` to explore all 200+ available templates across 15+ categories! ## ๐Ÿ“‹ Core Commands Master Rawi's powerful command set: ### ๐Ÿ—ฃ๏ธ `rawi ask` โ€” Your AI Assistant The heart of Rawi - ask questions and get intelligent responses. ```bash # Basic questions rawi ask "How do I optimize this SQL query?" # Use specific profiles for different projects rawi ask "Review this code" --profile work # ๐Ÿ†• Enhanced Session Management rawi ask "What about performance optimization?" --session abc123 rawi ask "Start new discussion" --new-session rawi ask "Continue from list" --list-sessions rawi ask "Named session" --session-name "API Design Discussion" # Apply specialized AI personas rawi ask --act security-expert "Analyze this authentication logic" # Pipe input for analysis cat server.js | rawi ask "Review this Express server for security issues" git diff | rawi ask "Write a conventional commit message for these changes" # Session management options rawi ask "Show session details" --show-session-id rawi ask "Export this conversation" --export-session abc123 rawi ask "Rename session" --rename-session "New Session Name" ``` ### ๐Ÿ’ฌ `rawi chat` โ€” Interactive Conversations Start interactive chat sessions for back-and-forth conversations with AI. ```bash # Start an interactive chat session rawi chat # Use specific profile for the chat session rawi chat --profile work # Apply a specialized persona for the entire chat rawi chat --act ethereum-developer # Start chat with verbose information rawi chat --verbose # ๐Ÿ†• Session Management Options rawi chat --new-session # Force create new session rawi chat --session abc123 # Continue specific session rawi chat --session-name "Project X" # Start with custom session name rawi chat --list-sessions # List and select from existing sessions rawi chat --export-session abc123 # Export session to JSON file # Advanced session options rawi chat --show-session-id # Display current session ID rawi chat --session-stats # Show session statistics rawi chat --rename-session "New Name" # Rename current session # Chat commands within a session # /help - Show chat commands # /quit - Exit the chat (also /exit) # /clear - Clear conversation history # /session - Show current session info # /sessions - List all sessions # /export - Export current session # /rename - Rename current session # /new - Start new session ``` **Perfect for:** - Code reviews with multiple rounds of feedback - Brainstorming sessions - Technical discussions - Learning and exploration - Problem-solving conversations ### โšก `rawi exec` โ€” Command Generation Convert natural language descriptions into executable CLI commands with safety validation. ```bash # Basic command generation rawi exec "list all files in current directory" rawi exec "show disk usage for home directory" rawi exec "find all Python files larger than 1MB" # Use with piped input echo "compress all log files" | rawi exec printf "backup database\n" | rawi exec --dry-run # Interactive mode (prompts for description) rawi exec # Safety and validation options rawi exec "restart nginx service" --dry-run # Preview without executing rawi exec "delete old files" --confirm # Force confirmation prompt rawi exec "long backup process" --timeout 300 # Set custom timeout rawi exec "show network config" --copy-command # Copy command to clipboard # Use specific profile rawi exec "server deployment commands" --profile production # Verbose output with debugging rawi exec "complex git operations" --verbose ``` **Perfect for:** - System administration and server management - Development workflow automation - Learning new CLI tools and their syntax - File operations and data processing - Quick one-off command generation **Safety Features:** - Command validation and safety checks - Dry-run mode for preview without execution - Timeout protection for long-running commands - User confirmation for potentially dangerous operations ### โš™๏ธ `rawi configure` โ€” Setup & Management Easy setup and profile management for all your AI providers. ```bash # Interactive setup (recommended for beginners) rawi configure # Quick provider setup rawi configure --provider openai --model gpt-4o --api-key sk-xxx # Advanced configuration with all options rawi configure --provider anthropic \ --model claude-3-5-sonnet-20241022 \ --api-key sk-ant-xxx \ --temperature 0.7 \ --max-tokens 4096 # Profile management rawi configure --list # List all profiles rawi configure --show # Show current config rawi configure --show --profile work # Show specific profile rawi configure --delete old-profile # Delete profile ``` ### ๐Ÿ“š `rawi history` โ€” Conversation Management Powerful tools to manage your AI conversation history with separate views for ask and chat sessions. ```bash # Basic history commands rawi history ask # Show ask session history rawi history chat # Show chat session history rawi history exec # Show exec session history # Session listings with filtering rawi history ask --limit 10 # Show last 10 ask sessions rawi history chat --all-profiles # Show chat sessions from all profiles rawi history exec --limit 5 # Show last 5 exec sessions rawi history ask --search "docker" # Search ask sessions for "docker" rawi history chat --provider openai # Show chat sessions using OpenAI rawi history exec --search "git" # Search exec sessions for "git" # Advanced filtering options rawi history ask --from 2024-01-01 # Ask sessions from specific date rawi history chat --model gpt-4 # Chat sessions using specific model rawi history exec --profile work # Exec sessions from work profile rawi history ask --profile work # Ask sessions from work profile rawi history chat --to 2024-12-31 # Chat sessions up to specific date # Search across message content rawi history ask --search "debugging react" rawi history chat --search "typescript errors" rawi history exec --search "system commands" # Provider and model filtering rawi history ask --provider ollama --model llama3.2 rawi history chat --provider anthropic --model claude-3-5-sonnet rawi history exec --provider openai --model gpt-4 ``` ### ๐ŸŽญ `rawi act` โ€” Template Explorer Discover and use specialized AI personas. ```bash # Browse all available templates rawi act --list # Show detailed template information rawi act --show ethereum-developer # Search templates (use with grep) rawi act --list | grep -i security ``` ### ๐Ÿ”ง `rawi provider` โ€” Provider Information Explore AI providers and their capabilities. ```bash # List all supported providers rawi provider --list # Show available models for specific provider rawi provider --list-models openai rawi provider --list-models anthropic ``` ### โ„น๏ธ `rawi info` โ€” System Information Get information about Rawi and your configuration. ```bash # Show system information rawi info # Show profile details rawi info --profiles ``` ## ๏ฟฝ Session Management โ€” Persistent AI Conversations Rawi's advanced session management system lets you maintain context across conversations, organize your AI interactions, and never lose track of important discussions. ### ๐ŸŽฏ What Are Sessions? Sessions are persistent conversation threads that: - **Preserve context** โ€” AI remembers your entire conversation history - **Maintain organization** โ€” Group related discussions together - **Enable continuation** โ€” Resume conversations from where you left off - **Provide insights** โ€” Track usage statistics and conversation metrics ### ๐Ÿš€ Quick Session Examples ```bash # Start a focused work session rawi chat --session-name "API Design Review" --profile work # Continue yesterday's conversation rawi ask "What about the security concerns we discussed?" --session abc123 # List and select from your sessions interactively rawi ask "Continue where we left off" --list-sessions # Export important conversations rawi history export abc123 --output "project-discussion.json" ``` ### ๐Ÿ’ก Session Workflow Examples **๐Ÿ“‹ Project Planning Session** ```bash # Start dedicated project session rawi chat --session-name "E-commerce Platform Design" --act solution-architect # Within chat: plan architecture, discuss features, review decisions # Exit and continue later rawi ask "Let's finalize the database schema" --session ecommerce-123 ``` **๐Ÿ› Debugging Session** ```bash # Start debugging session with context rawi ask "I'm getting authentication errors" --new-session --act debugging-expert # Continue with code snippets and logs cat error.log | rawi ask "Analyze these authentication errors" --session debug-456 # Come back with solutions rawi ask "The JWT validation fix worked, now what about rate limiting?" --session debug-456 ``` **๐Ÿ“š Learning Session** ```bash # Long-term learning conversation rawi chat --session-name "Machine Learning Journey" --act ai-instructor # Build knowledge over multiple days rawi ask "Yesterday we covered neural networks, today let's discuss transformers" --session ml-789 ``` ### ๐Ÿ› ๏ธ Session Operations **Create and Name Sessions** ```bash rawi chat --session-name "Sprint Planning Q1" # Named interactive session rawi ask "Quick question" --new-session # Force new session ``` **Navigate and Select Sessions** ```bash rawi history sessions # List all sessions rawi history sessions --interactive # Pick from interactive list rawi chat --list-sessions # Select session for chat ``` **Session Information** ```bash rawi history show abc123 # View full conversation rawi history sessions --stats # Usage statistics rawi chat --show-session-id # Display current session ID ``` **Organize and Clean Up** ```bash rawi history rename abc123 "Updated Name" # Rename sessions rawi history delete abc123 # Remove unwanted sessions rawi history cleanup --days 30 # Bulk cleanup old sessions ``` **Export and Backup** ```bash rawi history export abc123 # Export single session rawi history export --output "backup.json" # Export all history ``` ### ๐ŸŽจ Session Best Practices 1. **๐Ÿท๏ธ Use Meaningful Names** โ€” Create sessions with descriptive names for important topics 2. **๐Ÿ“ Organize by Profile** โ€” Use different profiles for work, personal, and project contexts 3. **๐Ÿ”„ Continue Related Discussions** โ€” Keep context by continuing relevant sessions 4. **๐Ÿงน Clean Up Regularly** โ€” Remove old or temporary sessions to stay organized 5. **๐Ÿ’พ Export Important Conversations** โ€” Backup valuable discussions and insights ### ๐Ÿ“ˆ Session Analytics Track your AI usage patterns: ```bash # Overall statistics rawi history stats # Shows: Total sessions, messages, provider usage, time patterns # Session-specific metrics rawi history sessions --table # Shows: Session IDs, names, message counts, creation dates # Usage insights rawi history sessions --profile work --stats # Shows: Work-specific session analytics ``` ### ๐Ÿ”ง Advanced Session Features **Interactive Selection with Full IDs** - Sessions display complete identifiers (no truncation) - Table format shows all session details clearly - Interactive prompts for easy session selection **Smart Session Continuation** - Automatic session detection based on context - Profile-aware session grouping - Intelligent session suggestions **Export Capabilities** - JSON format with full conversation history - Metadata preservation (timestamps, providers, models) - Batch export options for backup and analysis ### ๐Ÿ“š Session Documentation - [**Detailed Session Guide**](./docs/sessions.md) โ€” Complete session management documentation - [**History Command Reference**](./docs/commands/history.md) โ€” All history command options - [**Ask Command Guide**](./docs/commands/ask.md) โ€” Session options for ask command ## ๏ฟฝ๐Ÿ› ๏ธ Configuration Made Simple Get up and running with any AI provider in minutes: ### ๐Ÿš€ Quick Provider Setup ```bash # OpenAI (most popular - great for general development) rawi configure --provider openai --model gpt-4o --api-key sk-your-key # Anthropic Claude (excellent for analysis and safety) rawi configure --provider anthropic --model claude-3-5-sonnet-20241022 --api-key sk-ant-xxx # Google Gemini (fast and efficient) rawi configure --provider google --model gemini-2.0-flash-exp --api-key AIza-xxx # DeepSeek (cost-effective with reasoning capabilities) rawi configure --provider deepseek --model deepseek-chat --api-key sk-your-deepseek-key # Ollama (completely free and private) rawi configure --provider ollama --model llama3.2 ``` ### ๐Ÿข Enterprise & Advanced ```bash # Azure OpenAI for enterprise deployments rawi configure --provider azure \ --model your-deployment-name \ --resource-name your-resource \ --api-key your-azure-key # AWS Bedrock with credential chain rawi configure --provider bedrock \ --model anthropic.claude-3-sonnet-20240229-v1:0 \ --use-provider-chain \ --region us-west-2 # Multiple profiles for different projects rawi configure --profile work --provider openai --model gpt-4o rawi configure --profile personal --provider ollama --model llama3.2 rawi configure --profile enterprise --provider azure --model gpt-4o ``` ### ๐ŸŽ›๏ธ Fine-Tuning Options ```bash # Customize AI behavior rawi configure --provider openai \ --model gpt-4o \ --temperature 0.7 \ --max-tokens 4096 \ --language english # Multi-language support rawi configure --language arabic # Full Arabic support ``` ## ๐Ÿ’ผ Developer Workflow Integration See how Rawi integrates seamlessly into your development workflow: ### ๐Ÿ” Code Review & Analysis ```bash # Review git changes before committing git diff | rawi ask "Review these changes for potential issues" # Security analysis of entire files cat src/auth.js | rawi ask --act security-expert "Analyze for vulnerabilities" # Get improvement suggestions rawi ask --act code-reviewer "How can I optimize this function?" < utils.py # Generate conventional commit messages git diff --cached | rawi ask "Write a conventional commit message" # Create release notes git log --oneline $(git describe --tags --abbrev=0)..HEAD | \ rawi ask "Create release notes from these commits" # Summarize branch changes git log --oneline main..feature-branch | \ rawi ask "Summarize the changes in this feature branch" ``` ### ๐Ÿ› Debugging & Problem Solving ```bash # Debug specific error messages rawi ask "Fix this Python error: NameError: name 'x' is not defined" # Analyze application logs tail -100 /var/log/app.log | rawi ask "Summarize errors and suggest fixes" # Understand complex algorithms rawi ask --act code-reviewer "Explain this algorithm step by step" < algorithm.py # Database performance optimization rawi ask --act database-admin "Optimize this slow query" < queries.sql ``` ### ๐Ÿ“ Documentation & Generation ```bash # Generate API documentation rawi ask --act tech-writer "Document this API endpoint" < api.js # Create comprehensive README files rawi ask "Create a comprehensive README for this project" < package.json # Write comprehensive test cases rawi ask --act qa-engineer "Generate unit tests for this function" < utils.js # Generate Docker configurations rawi ask "Generate Docker configuration for this Node.js app" ``` ### ๐Ÿ”ง Automation & Scripting ```bash # Generate CI/CD workflows rawi ask "Create a GitHub Actions workflow for CI/CD" > .github/workflows/deploy.yml # Create command automation rawi exec "create a backup script for all project files" rawi exec "setup development environment for new team member" # Create backup scripts rawi ask "Create a database backup script for PostgreSQL" > backup.sh # Execute system tasks rawi exec "find and clean up old log files safely" echo "optimize system performance" | rawi exec --dry-run # Generate server configurations rawi ask "Generate nginx config for this Express app" > nginx.conf # Transform data formats cat data.json | rawi ask "Transform this JSON into CSV format" > data.csv ``` ### ๐Ÿ“Š Data Analysis & Processing ```bash # Analyze CSV datasets cat sales-data.csv | rawi ask "Analyze this sales data and identify trends" # Process API responses curl -s api.example.com/data | rawi ask "Explain this API response structure" # Log analysis and monitoring grep ERROR app.log | rawi ask "Categorize these errors and suggest fixes" # Configuration review cat docker-compose.yml | rawi ask "Review this Docker configuration for best practices" ``` ### ๐Ÿ“„ Document & File Processing Process and analyze various document formats with intelligent content extraction: ```bash # PDF document analysis rawi ask --file report.pdf "Summarize the key findings in this report" # Code review from files rawi ask --file src/app.js "Review this code for potential improvements" # Excel data analysis rawi ask --file sales-data.xlsx "What trends do you see in this data?" # Microsoft Word document processing rawi ask --file requirements.docx "Extract the main requirements from this document" # Multiple file processing rawi ask --files config.json package.json "Compare these configuration files" # Batch processing with glob patterns rawi ask --batch "src/**/*.{js,ts}" "Review all TypeScript/JavaScript files for consistency" # Process files with specific templates rawi ask --file database-schema.sql --act database-admin "Analyze this schema for optimization" # Combine file content with prompts rawi ask --file error-logs.txt "Analyze these logs and suggest solutions" ``` **Supported File Formats:** - **๐Ÿ“„ PDF** โ€” Extract text from PDF documents - **๐Ÿ“ DOCX** โ€” Microsoft Word documents - **๐Ÿ“Š XLSX** โ€” Excel spreadsheets with sheet selection - **๐Ÿ“‹ Text Files** โ€” .txt, .md, .json, .js, .py, .sql, .yml, etc. - **๐Ÿ” Source Code** โ€” All programming languages with syntax context **Advanced File Features:** ```bash # Process specific Excel sheets rawi ask --file data.xlsx --sheet "Q4 Sales" "Analyze Q4 performance" # Override file type detection rawi ask --file data.unknown --file-type txt "Process this as plain text" # Parallel processing for speed rawi ask --batch "docs/**/*.md" --parallel "Create a documentation index" # Continue processing on errors rawi ask --batch "**/*.json" --continue-on-error "Validate all JSON files" # Verbose output for debugging rawi ask --file large-dataset.csv --verbose "Summarize this data" ``` ## ๐Ÿ“ฆ Installation ### NPM (Recommended) ```bash # Install globally via npm npm install -g rawi # Or using yarn yarn global add rawi # Or using pnpm pnpm add -g rawi # Or using bun bun add -g rawi ``` ### Alternative Package Managers ```bash # Using npx (no installation required) npx rawi ask "What is TypeScript?" # Using homebrew (macOS/Linux) brew install rawi # Coming soon # Using scoop (Windows) scoop install rawi # Coming soon ``` ### Verify Installation ```bash rawi --version rawi info ``` ### Shell Completion (Optional) Enable shell completion for faster and more efficient CLI usage: ```bash # Auto-detect shell and install completion rawi completion --install # Or specify your shell explicitly rawi completion bash --install # For bash rawi completion zsh --install # For zsh rawi completion fish --install # For fish # Just generate without installing rawi completion bash # Creates ~/.rawi/completion/rawi-completion.bash ``` After installation, restart your terminal or source your shell profile: ```bash # For bash source ~/.bashrc # For zsh source ~/.zshrc # For fish source ~/.config/fish/config.fish ``` ### System Requirements - **Node.js**: 18.0.0 or higher - **Operating System**: Windows, macOS, Linux - **Terminal**: Any modern terminal (Terminal.app, iTerm2, Windows Terminal, etc.) ### Platform-Specific Notes All platforms (Windows, macOS, Linux) support full `rawi exec` functionality with command generation, execution, and safety prompts. --- ## ๐Ÿšฆ Getting Started Guide ### Step 1: Install Rawi ```bash npm install -g rawi ``` ### Step 2: Choose Your AI Provider Pick one of these popular options: **๐Ÿ”ต OpenAI (Recommended for beginners)** ```bash # Get API key from: https://platform.openai.com/api-keys rawi configure --provider openai --model gpt-4o --api-key sk-your-key ``` **๐ŸŸข Ollama (Free & Private)** ```bash # Install Ollama first: https://ollama.com/download ollama pull llama3.2 rawi configure --provider ollama --model llama3.2 ``` **๐ŸŸฃ Anthropic Claude (Great for analysis)** ```bash # Get API key from: https://console.anthropic.com/ rawi configure --provider anthropic --model claude-3-5-sonnet-20241022 --api-key sk-ant-xxx ``` ### Step 3: Start Using Rawi ```bash # Ask your first question rawi ask "Explain the difference between REST and GraphQL" # Try with code analysis echo "console.log('Hello World')" | rawi ask "Optimize this JavaScript code" # Use a specialized template rawi ask --act security-expert "What are common web security vulnerabilities?" ``` ### Step 4: Explore Advanced Features ```bash # Browse available templates rawi act --list # Check your conversation history rawi history # See all available providers rawi provider --list ``` --- ## ๐Ÿค Contributing We welcome contributions! Here's how you can help: ### ๐Ÿ› Found a Bug? 1. Check [existing issues](https://github.com/withrawi/rawi/issues) 2. Create a [new bug report](https://github.com/withrawi/rawi/issues/new?template=bug.yml) 3. Include Rawi version (`rawi --version`) and environment details ### ๐Ÿ’ก Have an Idea? 1. Check [feature requests](https://github.com/withrawi/rawi/issues?q=is%3Aissue+is%3Aopen+label%3Aenhancement) 2. Create a [new feature request](https://github.com/withrawi/rawi/issues/new?template=feat.yml) 3. Describe your use case and expected behavior ### ๐Ÿ”ง Want to Code? 1. Fork the repository 2. Create a feature branch (`git checkout -b feature/amazing-feature`) 3. Make your changes 4. Add tests if applicable 5. Commit your changes (`git commit -m 'Add some amazing feature'`) 6. Push to the branch (`git push origin feature/amazing-feature`) 7. Open a Pull Request ### ๐Ÿ“ Improve Documentation - Fix typos and improve clarity - Add more examples and use cases - Translate documentation to other languages - Create video tutorials and guides **Read our full [Contributing Guide](./.github/CONTRIBUTING.md) for detailed information.** --- ## ๐Ÿ“š Documentation - **[๐Ÿ“– Getting Started](https://rawi.mkabumattar.com/getting-started/)** โ€” Complete setup guide - **[โš™๏ธ Configuration](https://rawi.mkabumattar.com/configure/)** โ€” Provider setup and options - **[๐Ÿ› ๏ธ Commands](https://rawi.mkabumattar.com/reference/)** โ€” Detailed command reference - **[โ“ FAQ](https://rawi.mkabumattar.com/help/faq)** โ€” Common questions - **[๐Ÿ› ๏ธ Troubleshooting](https://rawi.mkabumattar.com/help/troubleshooting/)** โ€” Fix common issues --- ## ๐Ÿ“„ License Rawi is licensed under the [MIT License](./LICENSE). --- ## ๐Ÿ‘จโ€๐Ÿ’ป Author **Mohammad Abu Mattar** - Website: [mkabumattar.github.io](https://mkabumattar.github.io) - Email: [mohammad.khaled@outlook.com](mailto:mohammad.khaled@outlook.com) - GitHub: [@MKAbuMattar](https://github.com/MKAbuMattar) --- ## โญ Show Your Support If Rawi helps you be more productive, consider: - โญ **Star this repository** on GitHub - ๐Ÿ› **Report bugs** and suggest improvements - ๐Ÿ“ **Contribute** to the codebase - ๐Ÿ“ข **Share** with your developer community - ๐Ÿ’ **Sponsor** the project ---
**Made with โค๏ธ for developers worldwide** [๐ŸŒ Website](https://rawi.mkabumattar.com) โ€ข [๐Ÿ“š Docs](https://rawi.mkabumattar.com/userguide) โ€ข [๐Ÿ’ฌ Discussions](https://github.com/withrawi/rawi/discussions) โ€ข [๐Ÿ› Issues](https://github.com/withrawi/rawi/issues)