User Guides
Comprehensive guides for installing, configuring, and using Claif effectively.
Getting Started
Quick Start
Get up and running with Claif in minutes:
- Install Claif
uv pip install claif
- Install a Provider
uv pip install claif_gem # or claif_cla, claif_cod
- Configure API Keys
claif config
- Make Your First Query
claif query "What is 2+2?" --provider gemini
Essential Guides
Installation Guide
Complete installation instructions for all platforms:
- Python environment setup
- Package installation with uv/pip
- Provider package installation
- System requirements and dependencies
Configuration Guide
Comprehensive configuration setup:
- API key management
- Provider-specific settings
- Configuration file formats (TOML)
- Environment variables
- Advanced configuration options
CLI Usage Guide
Master the command-line interface:
- All available commands and options
- Query formatting and examples
- Provider selection strategies
- Verbose output and debugging
- Batch operations and scripting
Integration Guide
Use Claif programmatically:
- Python API usage
- Async operations
- Error handling patterns
- Custom workflows
- CI/CD integration
Migration Guide
Upgrade between versions:
- Breaking changes by version
- Configuration migration
- Provider updates
- Deprecation notices
Advanced Topics
Performance Optimization
- Query optimization strategies
- Concurrent provider usage
- Caching and persistence
- Resource management
Security Best Practices
- API key protection
- Secure configuration
- Network security
- Input validation
Troubleshooting
- Common error resolution
- Debug mode usage
- Log analysis
- Performance debugging
Navigation
- Installation - Setup and installation
- Configuration - API keys and settings
- CLI Usage - Command-line interface
- Integration - Programmatic usage
- Migration - Version upgrades