info — System Information
Get detailed information about your Rawi installation, configuration, and system status.
Basic Usage
Section titled “Basic Usage”rawi info [options]
Quick Commands
Section titled “Quick Commands”# Show general system informationrawi info
# Show configured profilesrawi info --profiles
# Show supported providersrawi info --providers
Options
Section titled “Options”Option | Description |
---|---|
--profiles | Display all configured profiles and their settings |
--providers | Show supported AI providers and their capabilities |
--help | Show command help and examples |
Examples
Section titled “Examples”System Information
Section titled “System Information”Get a comprehensive overview of your Rawi installation:
rawi info
Output includes:
- Version information
- Author and license details
- Total number of configured profiles
- Available AI providers
- Current default profile
- Installation path
- Configuration location
Example Output:
🚀 About Rawi (راوي) https://rawi.mkabumattar.com├─ Version: 1.0.0├─ Author: Mahmoud Kabumattar├─ License: MIT└─ Description: AI-powered CLI tool for developers
📊 Configuration Status├─ Profiles: 3 configured├─ Default Profile: development├─ Providers: 9 available└─ Templates: 200+ expert prompts
💾 System Paths├─ Installation: /usr/local/bin/rawi├─ Configuration: ~/.config/rawi/├─ History: ~/.config/rawi/history/└─ Templates: ~/.config/rawi/templates/
Profile Overview
Section titled “Profile Overview”View all your configured profiles:
rawi info --profiles
Shows for each profile:
- Profile name and status
- Configured AI provider
- Default model
- Creation date
- Last used date
- Number of conversations
Example Output:
👤 Configured Profiles┌─────────────┬──────────┬─────────────┬─────────────┬──────────────┐│ Profile │ Provider │ Model │ Created │ Conversations│├─────────────┼──────────┼─────────────┼─────────────┼──────────────┤│ development │ openai │ gpt-4 │ 2024-01-15 │ 42 ││ local │ ollama │ llama2 │ 2024-01-20 │ 15 ││ production │ anthropic│ claude-3 │ 2024-01-25 │ 8 │└─────────────┴──────────┴─────────────┴─────────────┴──────────────┘
🌟 Default Profile: development
Provider Information
Section titled “Provider Information”View supported AI providers and their capabilities:
rawi info --providers
Shows for each provider:
- Provider name and status
- Available models
- Authentication requirements
- Special features
- Connection status
Example Output:
🤖 Supported AI Providers
┌─────────────┬─────────┬──────────────┬─────────────────┐│ Provider │ Status │ Models │ Authentication │├─────────────┼─────────┼──────────────┼─────────────────┤│ OpenAI │ ✅ Ready│ gpt-4, gpt-3.5│ API Key ││ Anthropic │ ✅ Ready│ claude-3 │ API Key ││ Google │ ✅ Ready│ gemini-pro │ API Key ││ Ollama │ ⚠️ Local│ llama2, llama│ None ││ Azure │ ❌ Config│ gpt-4 │ API Key + Resource││ Bedrock │ ❌ Config│ claude-3 │ AWS Credentials ││ xAI │ ❌ Config│ grok-1 │ API Key ││ LM Studio │ ❌ Config│ Various │ None │└─────────────┴─────────┴──────────────┴─────────────────┘
Legend:✅ Ready - Configured and working⚠️ Local - Local provider available❌ Config - Needs configuration
Understanding the Output
Section titled “Understanding the Output”Status Indicators
Section titled “Status Indicators”Symbol | Meaning |
---|---|
✅ | Configured and working |
⚠️ | Available but not configured |
❌ | Not configured or unreachable |
🔄 | Currently being tested |
Configuration Paths
Section titled “Configuration Paths”The info command shows important file locations:
- Configuration:
~/.config/rawi/
(main config directory) - Profiles:
~/.config/rawi/profiles/
(profile-specific settings) - History:
~/.config/rawi/history/
(conversation history) - Templates:
~/.config/rawi/templates/
(act templates)
Use Cases
Section titled “Use Cases”Troubleshooting Setup
Section titled “Troubleshooting Setup”When experiencing issues, run rawi info
to check:
# Full system checkrawi info
# Check specific profile configurationrawi info --profiles
# Verify provider availabilityrawi info --providers
Health Monitoring
Section titled “Health Monitoring”Regular health checks of your Rawi setup:
# Quick status checkrawi info | grep -E "(Version|Profiles|Default)"
# Profile usage monitoringrawi info --profiles | grep "Conversations"
# Provider connectivity checkrawi info --providers | grep -E "(Ready|Config)"
System Information for Support
Section titled “System Information for Support”When seeking help, provide system information:
# Generate support informationecho "=== Rawi System Information ===" > support-info.txtrawi info >> support-info.txtecho "=== Profile Details ===" >> support-info.txtrawi info --profiles >> support-info.txtecho "=== Provider Status ===" >> support-info.txtrawi info --providers >> support-info.txt
Advanced Usage
Section titled “Advanced Usage”JSON Output
Section titled “JSON Output”For scripting and automation:
# Get info as JSON (if supported)rawi info --json
# Parse specific informationrawi info --json | jq '.profiles[] | select(.name == "development")'
Status Monitoring Scripts
Section titled “Status Monitoring Scripts”#!/bin/bash# Check if Rawi is properly configuredif rawi info --providers | grep -q "✅"; then echo "✅ Rawi has configured providers" exit 0else echo "❌ Rawi needs configuration" exit 1fi
Profile Migration Check
Section titled “Profile Migration Check”# Check profiles before migrationecho "Current profiles:"rawi info --profiles
# Backup before changescp -r ~/.config/rawi/ ~/rawi-backup-$(date +%Y%m%d)/
Integration with Other Commands
Section titled “Integration with Other Commands”The info
command works well with other Rawi commands:
Pre-Configuration Check
Section titled “Pre-Configuration Check”# Check current state before configuringrawi info --providersrawi configure --provider openai
Profile Management Workflow
Section titled “Profile Management Workflow”# Review existing profilesrawi info --profiles
# Create new profilerawi configure --profile new-profile
# Verify new profilerawi info --profiles | grep new-profile
Health Check Routine
Section titled “Health Check Routine”# Daily health checkrawi info > daily-status.logif grep -q "❌" daily-status.log; then echo "⚠️ Configuration issues detected"fi
Troubleshooting
Section titled “Troubleshooting”No Profiles Found
Section titled “No Profiles Found”If rawi info
shows no profiles:
# Create your first profilerawi configure
# Verify creationrawi info --profiles
Provider Connection Issues
Section titled “Provider Connection Issues”If providers show as unreachable:
# Check network connectivityping -c 1 api.openai.com
# Test API keyrawi configure --test
# Check firewall settingsnetstat -an | grep :443
Configuration Directory Issues
Section titled “Configuration Directory Issues”If configuration cannot be accessed:
# Check directory permissionsls -la ~/.config/rawi/
# Create directory if missingmkdir -p ~/.config/rawi/profiles/
# Fix permissionschmod 755 ~/.config/rawi/chmod 644 ~/.config/rawi/config.json
Outdated Information
Section titled “Outdated Information”Information is cached briefly. To force refresh:
# Clear cache and refreshrawi info --refresh
# Restart for complete refreshrawi info
Output Customization
Section titled “Output Customization”Filtering Output
Section titled “Filtering Output”# Show only profile namesrawi info --profiles | grep "│" | awk '{print $2}'
# Show only ready providersrawi info --providers | grep "✅"
# Count configurationsrawi info | grep "Profiles:" | cut -d' ' -f2
Custom Formats
Section titled “Custom Formats”# Compact formatrawi info --compact
# Verbose format with detailsrawi info --verbose
# Table format for profilesrawi info --profiles --format table
Best Practices
Section titled “Best Practices”Regular Monitoring
Section titled “Regular Monitoring”- Daily Checks: Include
rawi info
in daily development scripts - Profile Reviews: Weekly review of profile usage with
--profiles
- Provider Status: Monitor provider connectivity before important tasks
Documentation
Section titled “Documentation”- System Documentation: Include
rawi info
output in system documentation - Team Onboarding: Use provider info to guide team setup
- Troubleshooting Guides: Reference specific info outputs
Automation
Section titled “Automation”- CI/CD Integration: Check Rawi status in deployment scripts
- Monitoring Scripts: Automated health checks using info command
- Backup Validation: Verify configuration after backups