* docs: add Supporting Other CLIs section with Claude Code, Codex and OpenCode
Adds a new documentation section covering how to use the Alias API
with third-party scaffoldings (Claude Code via proxy, Codex CLI, and
OpenCode). Includes privacy/security warning banners and support
disclaimers on each page.
* docs: update Claude Code setup to use env vars instead of proxy
* docs: clarify usage data collection scope and GDPR basis
Expand the Usage Data Collection section to explicitly mention model
training and evaluation as purposes of data collection, separate the
GDPR legal basis into its own paragraph for readability, and refine
the closing note about CAI_TELEMETRY.
Remove council page and nav; drop obsolete slash commands from docs (/config,
/context, /platform, /kill, /model-show); document /env, /model show, and
CLI examples. Update README, MkDocs, and PRO pages for usage visibility.
- Document /help, /help var, and /config for in-session env discovery
(environment_variables.md, configuration.md, FAQ, CLI reference pages).
- Add Values/When columns and a field guide aligned with REPL /help tables.
Co-authored-by: Rufino Cabrera <rufino@aliasrobotics.com>
docs: add Supporting Other CLIs section with Claude Code, Codex and OpenCode
Adds a new documentation section covering how to use the Alias API
with third-party scaffoldings (Claude Code via proxy, Codex CLI, and
OpenCode). Includes privacy/security warning banners and support
disclaimers on each page.
* feat: Add Ollama Cloud integration with ollama_cloud/ prefix
- Added support for Ollama Cloud models via AsyncOpenAI
- Models use ollama_cloud/ prefix (e.g., ollama_cloud/gpt-oss:120b)
- Reads OLLAMA_API_KEY and OLLAMA_API_BASE for cloud authentication
- Added predefined Ollama Cloud models to /model-show
- Filtered obsolete ollama/*-cloud models from LiteLLM database
- Updated authentication headers in completer, banner, and toolbar
- Added concise English documentation in docs/providers/
- Adapted to new global model cache architecture from #371
Modified files:
- src/cai/sdk/agents/models/openai_chatcompletions.py
- src/cai/repl/commands/model.py (adapted to global cache)
- src/cai/util.py
- src/cai/repl/commands/completer.py
- src/cai/repl/ui/banner.py
- src/cai/repl/ui/toolbar.py
- docs/providers/ollama.md
- docs/providers/ollama_cloud.md
All existing functionality preserved (backward compatible).
* fix: Add missing Ollama Cloud models and get_ollama_auth_headers
- Added Ollama Cloud models to get_predefined_model_categories()
- Added get_ollama_auth_headers() function to util.py
- Added Ollama Cloud to category_to_provider mapping
- Imported get_ollama_auth_headers in model.py
This fixes the issue where predefined models weren't showing in /model-show.
* fix: Display predefined models first in /model-show
- Added loop to display predefined models (Alias, Claude, OpenAI, DeepSeek, Ollama Cloud) before LiteLLM models
- Models #1-14 now correctly show predefined models
- LiteLLM models start from #15+ as expected
- Added get_ollama_auth_headers() function in util.py for Ollama Cloud auth
- Fixed model numbering to be consistent with global cache
This resolves the issue where predefined models were skipped and only LiteLLM models appeared starting from #15.
* fix: Restore correct import of cai.caibench instead of pentestperf
During rebase, the import was incorrectly changed from 'import cai.caibench as ptt'
to 'import pentestperf as ptt'. This commit restores the correct import.
The original code uses cai.caibench, not an external pentestperf module.
* docs: add three new case studies to README
- Add Unitree G1 Humanoid Robot security analysis case study
- Add Dragos OT CTF 2025 Top-10 achievement case study
- Add HackerOne bug bounty platform case study
- Include case study images in docs/assets/images/
- Position new studies at the top as most recent
- Maintain consistent formatting with existing case studies
* docs: update case study descriptions with official text from web pages
- Update Unitree G1 description with official text
- Update Dragos CTF description with official text
- Update HackerOne description with official text
- Ensure consistency with published case studies
* docs: add PortSwigger case study to maintain 2-column structure
- Add PortSwigger Web Security Academy case study
- Position alongside MQTT broker in last row
- Maintain consistent 2-column layout throughout
- Include case study image in docs/assets/images/
* docs: update HackerOne case study title
- Remove 'and alias1' reference from HackerOne title
- Keep consistent naming with other case studies
* all agent are working, and docuemnted + benchmkar fixes
* revert
* Document extension of Red Team Agent
Added an example of extending the Red Team Agent with custom instructions.
---------
Co-authored-by: Maria <maria@aliasrobotics.com>
Co-authored-by: Francesco Balassone <77972200+duel0@users.noreply.github.com>
* Add installation guides in Markdown format for CAI Pro v0.5 and v0.6
* Add references to CAI Pro installation guides in README Install section
* Add Homebrew installation step for OS X in CAI Pro v0.5 guide
* Add navigation links back to README Install section in CAI Pro guides
---------
Co-authored-by: Rufino Cabrera <rufino@aliasrobotics.com>
* docs: add comprehensive CAI PRO documentation and CLI interface
- Add 5 new CAI PRO pages: Alias1 Model, Features, Pricing, Quick Start, Contact
- Create CLI documentation section with 4 pages
- Update mkdocs.yml navigation structure
- Improve commercial focus and user journey
- Clean titles
- Correct email addresses (contact@ for sales, support@ for tech support)
* style: improve navigation and TOC color scheme
- Apply green color palette (#529d86) to main navigation sections
- Enhance visual hierarchy with refined font weights and sizes
- Add subtle hover effects and transitions
- Style Table of Contents with matching color scheme
- Keep professional look with moderate font sizes (0.7-0.75rem)
- Maintain consistency with header green color across all navigation
docs: add comprehensive environment variables reference and update configuration
- Add new environment_variables.md with complete reference table and use case guides
- Update configuration.md table with default values and new variables
- Add CAI_GUARDRAILS, CAI_MAX_INTERACTIONS, CAI_STREAM, CAI_TELEMETRY, CAI_PARALLEL, CAI_GCTR_NITERATIONS, CAI_ACTIVE_CONTAINER
- Organize variables by use case: Getting Started, CTF, Memory, Security, Performance, Advanced, Container, TUI
- Add practical examples for common configurations
- Update mkdocs.yml navigation to include Environment Variables in Guides section
* docs: add TUI documentation index page
- Create docs/tui/ directory structure
- Add comprehensive TUI overview and index page
- Document TUI features: multi-terminal support, teams, parallel execution
- Add comparison table: TUI vs CLI use cases
- Include system requirements and supported terminals
- Document keyboard shortcuts and commands reference
- Add architecture overview and component structure
- Include quick start guide and documentation navigation
* docs: add TUI main interface screenshot
- Add cai-tui-main.png screenshot to docs/media/
- Screenshot shows TUI interface for documentation
* docs: add TUI getting started guide
- Add comprehensive getting-started.md for TUI
- Cover all 9 steps from launch to monitoring costs
- Include prerequisites and system requirements
- Document API key configuration process
- Explain model and agent selection
- Provide practical examples for first conversations
- Document multi-terminal workflows
- Explain team configurations
- Add troubleshooting section for common issues
- Include next steps and learning paths
* docs: improve security and update model information in getting-started
- Replace private IP 192.168.1.1 with documentation IP 198.51.100.50 (RFC 5737)
- Add GPT-5 model to available models table
- Add Claude 4-5 model to available models table
- Update model descriptions for clarity
- Ensure example IPs are safe for public documentation
* docs: minimum change
* docs: rename getting-started.md to getting_started.md for consistency
- Rename docs/tui/getting-started.md to getting_started.md (underscore format)
- Update all references in tui_index.md (3 occurrences)
- Maintain consistency with other markdown files naming convention
* docs: simplify TUI launch section in getting_started
- Remove alternative launch methods for cleaner first steps
- Remove 'Launch with Initial Prompt' section
- Remove 'Launch with YAML Configuration' section
- Focus on basic launch command for new users
* docs: prepare TUI docs for PR by managing broken links
- Replace broken documentation links with 🚧 indicators
- Add explanatory notes about documentation in development
- Convert inline links to plain text references
- Keep existing links (getting_started.md, cai_installation.md, cai_architecture.md)
- Maintain documentation structure for future expansion
* docs: add CAI-Pro exclusive banner to TUI documentation
* docs: add comprehensive TUI user interface documentation
* docs: improve TUI user-interface with enhanced topbar descriptions, layout screenshots, and reorganized command palette
* Minimal changes
* docs: update user-interface content
* docs: add comprehensive keyboard shortcuts reference for TUI
* Restructure
* docs: rename files to use underscores for consistency (keyboard_shortcuts, user_interface)
* docs: add comprehensive commands reference for TUI
* docs: update commands_reference with enhanced agent list, terminal targeting methods, and UI refinements
* docs: activate links for completed TUI documentation files
* docs: add terminals_management.md with multi-terminal workflows and layouts
* docs: add remaining layout images and refine terminals_management content
* docs: add CAI-5+terminals.png screenshot to media folder
* docs: fix formatting issue in terminals_management removing terminals section
* docs: add terminal anatomy screenshot to terminals_management
* docs: fix triple terminal layout description to accurately reflect three-column split
* docs: minimal fix
* docs: add sidebar_features.md with Teams, Queue, Stats, and Keys tabs documentation
* docs: update sidebar_features with correct team compositions, ALIAS1 info, and automatic queue behavior
* docs: fix code block formatting in sidebar_features ALIAS1 section
* docs: add teams_and_parallel_execution.md with coordination patterns and strategies
* docs: update model references to use alias models in teams_and_parallel_execution
* docs: add advanced_features.md with ICL, MCP, guardrails, and integration guides
* docs: refactor advanced_features - simplify MCP section with link to config guide, update model references, remove deprecated content
* docs: fix MCP configuration guide link path in advanced_features
* docs: standardize env vars and add guardrails documentation link in advanced_features
* docs: remove auto-save reference and help message in advanced_features
* docs: add troubleshooting guide for TUI
* docs: refine troubleshooting - remove install/launch sections, update command references
* docs: finalize tui_index - activate all doc links, remove flags and config/faq references
* docs: update installation guide link to new v0.6 documentation
* docs: remove broken link and fix formatting in TUI docs
* docs: fix TUI documentation issues and update CAI-Pro links
- Fix getting_started.md: remove 'coming soon' flags and activate all doc links
- Fix terminals_management.md: replace broken links with existing documentation
- Fix troubleshooting.md: remove non-existent configuration.md link
- Update all CAI-Pro banner links to point to cybersecurityai.php page
* docs: add TUI documentation index page
- Create docs/tui/ directory structure
- Add comprehensive TUI overview and index page
- Document TUI features: multi-terminal support, teams, parallel execution
- Add comparison table: TUI vs CLI use cases
- Include system requirements and supported terminals
- Document keyboard shortcuts and commands reference
- Add architecture overview and component structure
- Include quick start guide and documentation navigation
* docs: add TUI main interface screenshot
- Add cai-tui-main.png screenshot to docs/media/
- Screenshot shows TUI interface for documentation
* docs: add TUI getting started guide
- Add comprehensive getting-started.md for TUI
- Cover all 9 steps from launch to monitoring costs
- Include prerequisites and system requirements
- Document API key configuration process
- Explain model and agent selection
- Provide practical examples for first conversations
- Document multi-terminal workflows
- Explain team configurations
- Add troubleshooting section for common issues
- Include next steps and learning paths
* docs: improve security and update model information in getting-started
- Replace private IP 192.168.1.1 with documentation IP 198.51.100.50 (RFC 5737)
- Add GPT-5 model to available models table
- Add Claude 4-5 model to available models table
- Update model descriptions for clarity
- Ensure example IPs are safe for public documentation
* docs: minimum change
* docs: rename getting-started.md to getting_started.md for consistency
- Rename docs/tui/getting-started.md to getting_started.md (underscore format)
- Update all references in tui_index.md (3 occurrences)
- Maintain consistency with other markdown files naming convention
* docs: simplify TUI launch section in getting_started
- Remove alternative launch methods for cleaner first steps
- Remove 'Launch with Initial Prompt' section
- Remove 'Launch with YAML Configuration' section
- Focus on basic launch command for new users
* docs: prepare TUI docs for PR by managing broken links
- Replace broken documentation links with 🚧 indicators
- Add explanatory notes about documentation in development
- Convert inline links to plain text references
- Keep existing links (getting_started.md, cai_installation.md, cai_architecture.md)
- Maintain documentation structure for future expansion
* docs: add CAI-Pro exclusive banner to TUI documentation
* docs: add comprehensive TUI user interface documentation
* docs: improve TUI user-interface with enhanced topbar descriptions, layout screenshots, and reorganized command palette
* Minimal changes
* docs: update user-interface content
* docs: add comprehensive keyboard shortcuts reference for TUI
* Restructure
* docs: rename files to use underscores for consistency (keyboard_shortcuts, user_interface)
* docs: add comprehensive commands reference for TUI
* docs: update commands_reference with enhanced agent list, terminal targeting methods, and UI refinements
* docs: activate links for completed TUI documentation files
* docs: add terminals_management.md with multi-terminal workflows and layouts
* docs: add remaining layout images and refine terminals_management content
* docs: add CAI-5+terminals.png screenshot to media folder
* docs: fix formatting issue in terminals_management removing terminals section
* docs: add terminal anatomy screenshot to terminals_management
* docs: fix triple terminal layout description to accurately reflect three-column split
* docs: minimal fix
* docs: add sidebar_features.md with Teams, Queue, Stats, and Keys tabs documentation
* docs: update sidebar_features with correct team compositions, ALIAS1 info, and automatic queue behavior
* docs: fix code block formatting in sidebar_features ALIAS1 section
* docs: add teams_and_parallel_execution.md with coordination patterns and strategies
* docs: update model references to use alias models in teams_and_parallel_execution
* docs: add advanced_features.md with ICL, MCP, guardrails, and integration guides
* docs: refactor advanced_features - simplify MCP section with link to config guide, update model references, remove deprecated content
* docs: fix MCP configuration guide link path in advanced_features
* docs: standardize env vars and add guardrails documentation link in advanced_features
* docs: remove auto-save reference and help message in advanced_features
* docs: add troubleshooting guide for TUI
* docs: refine troubleshooting - remove install/launch sections, update command references
* docs: finalize tui_index - activate all doc links, remove flags and config/faq references
* docs: update installation guide link to new v0.6 documentation
* docs: remove broken link and fix formatting in TUI docs
* docs: add TUI documentation index page
- Create docs/tui/ directory structure
- Add comprehensive TUI overview and index page
- Document TUI features: multi-terminal support, teams, parallel execution
- Add comparison table: TUI vs CLI use cases
- Include system requirements and supported terminals
- Document keyboard shortcuts and commands reference
- Add architecture overview and component structure
- Include quick start guide and documentation navigation
* docs: add TUI main interface screenshot
- Add cai-tui-main.png screenshot to docs/media/
- Screenshot shows TUI interface for documentation
* docs: add TUI getting started guide
- Add comprehensive getting-started.md for TUI
- Cover all 9 steps from launch to monitoring costs
- Include prerequisites and system requirements
- Document API key configuration process
- Explain model and agent selection
- Provide practical examples for first conversations
- Document multi-terminal workflows
- Explain team configurations
- Add troubleshooting section for common issues
- Include next steps and learning paths
* docs: improve security and update model information in getting-started
- Replace private IP 192.168.1.1 with documentation IP 198.51.100.50 (RFC 5737)
- Add GPT-5 model to available models table
- Add Claude 4-5 model to available models table
- Update model descriptions for clarity
- Ensure example IPs are safe for public documentation
* docs: minimum change
* docs: rename getting-started.md to getting_started.md for consistency
- Rename docs/tui/getting-started.md to getting_started.md (underscore format)
- Update all references in tui_index.md (3 occurrences)
- Maintain consistency with other markdown files naming convention
* docs: simplify TUI launch section in getting_started
- Remove alternative launch methods for cleaner first steps
- Remove 'Launch with Initial Prompt' section
- Remove 'Launch with YAML Configuration' section
- Focus on basic launch command for new users
* docs: prepare TUI docs for PR by managing broken links
- Replace broken documentation links with 🚧 indicators
- Add explanatory notes about documentation in development
- Convert inline links to plain text references
- Keep existing links (getting_started.md, cai_installation.md, cai_architecture.md)
- Maintain documentation structure for future expansion
* docs: add CAI-Pro exclusive banner to TUI documentation
* docs: expand agents.md with comprehensive agent catalog and usage guides
- Add complete table of 12 of main available agents with descriptions, use cases, and key tools
- Add agent capabilities matrix with visual ratings for 7 capability categories
- Add 3 multi-agent workflow scenarios (Web Pentest, IoT Assessment, Incident Response)
- Add agent-specific configuration guides (redteam, bug bounty, DFIR)
- Add performance tips section with model comparison table
- Add best practices section with 5 practical examples
- Expand from ~150 to ~350 lines with actionable content
- Improve navigation with clear sections and next steps links
* docs: fix Launch section formatting in agents.md
- Change 'cai' plain text to proper bash code block
- Update heading from # to ### for consistency
- Improve visual consistency with other code examples
* docs: remove duplicate separator in agents.md
- Remove redundant --- separator before Next Steps section
- Improve document structure and readability