Commit Graph

143 Commits

Author SHA1 Message Date
Didier Durand 2ed9951cf2
[Doc]: fixing typos in different files (#364) 2025-12-08 09:16:53 +01:00
Didier Durand e3eeec4ec3
[Doc]: fixing typos in different files (#359) 2025-12-04 05:19:48 +01:00
Víctor Mayoral Vilches 93b17abdf7 Add Mobile UI docs
Signed-off-by: Víctor Mayoral Vilches <v.mayoralv@gmail.com>
2025-12-02 15:17:41 +01:00
Francesco Balassone 03e8ae8d7e
Added Council Docs (#355)
Co-authored-by: Francesco Balassone <77972200+balassone@users.noreply.github.com>
2025-12-01 17:42:07 +01:00
Víctor Mayoral Vilches 392ded1ac3 Document new open router selection capabilities
Signed-off-by: Víctor Mayoral Vilches <v.mayoralv@gmail.com>
2025-11-27 16:28:51 +01:00
Víctor Mayoral Vilches 43ecefcdff Add API capabilities in PRO to docs
Signed-off-by: Víctor Mayoral Vilches <v.mayoralv@gmail.com>
2025-11-19 13:10:07 +01:00
Mery-Sanz d6e8b0d561
Add custom tool example to agent (#347)
add custom tool example

Co-authored-by: Maria <maria@aliasrobotics.com>
2025-11-14 13:50:14 +01:00
Víctor Mayoral Vilches 28241117f2 Add C99 tool to docs
Signed-off-by: Víctor Mayoral Vilches <v.mayoralv@gmail.com>
2025-11-14 12:54:16 +01:00
Víctor Mayoral Vilches ccf823a2d5 Document --continue mode
Signed-off-by: Víctor Mayoral Vilches <v.mayoralv@gmail.com>
2025-11-14 12:41:43 +01:00
danielsanchezprieto01 e3b456f7f7
docs: add four new case studies to README (Unitree G1, Dragos CTF, HackerOne, PortSwigger) (#345)
* 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
2025-11-14 12:34:46 +01:00
Mery-Sanz 4e315531c1
Agent docs (#346)
* 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>
2025-11-14 11:46:27 +01:00
Víctor Mayoral Vilches 742ffe53a9 Add CAI_TOOL_TIMEOUT to docs
Signed-off-by: Víctor Mayoral Vilches <v.mayoralv@gmail.com>
2025-11-14 07:32:24 +01:00
Mery-Sanz 7c6a8b4893
Document on parallel agents (#337)
Document on parallel

Co-authored-by: Maria <maria@aliasrobotics.com>
2025-11-10 13:49:00 +01:00
RMtz88 054f3038de
Add installation guides in Markdown format for CAI Pro v0.5 and v0.6 (#312)
* 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>
2025-11-06 06:03:09 +01:00
danielsanchezprieto01 c6b21d9890
docs: Add comprehensive CAI PRO documentation, CLI section and improve website styling (#333)
* 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
2025-11-05 19:31:54 +01:00
jimbas 1354dd851f
Create lm_studio (#332)
Add LM studio models
2025-11-05 19:30:52 +01:00
danielsanchezprieto01 96ba5dc07e
docs: Add comprehensive environment variables reference (#330)
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
2025-11-04 19:19:12 +01:00
danielsanchezprieto01 e75d7a97fc
docs: Fix TUI documentation issues and update CAI-Pro links (#328)
* 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
2025-11-03 21:03:25 +01:00
Víctor Mayoral Vilches fde4c4aef4 minor improvements in docs
Signed-off-by: Víctor Mayoral Vilches <v.mayoralv@gmail.com>
2025-11-02 14:24:16 +00:00
Víctor Mayoral Vilches f5f3c42eb5 Rework documentation a bit, structure and aesthetics
Signed-off-by: Víctor Mayoral Vilches <v.mayoralv@gmail.com>
2025-11-01 18:21:14 +00:00
Víctor Mayoral Vilches c7a942eae3 Add CAI PRO badges
Signed-off-by: Víctor Mayoral Vilches <v.mayoralv@gmail.com>
2025-11-01 09:10:13 +00:00
Víctor Mayoral Vilches 6babb4ad94 Add documentation for /ctx
Signed-off-by: Víctor Mayoral Vilches <v.mayoralv@gmail.com>
2025-11-01 09:10:07 +00:00
danielsanchezprieto01 f00779186e
Docs/Adds comprehensive documentation for the CAI Terminal User Interface (TUI), covering all aspects from basic usage to advanced features. (#320)
* 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
2025-10-31 12:55:12 +01:00
yuri-alias faf9802d4c
Added missing step in OSX install documentation. (#317)
* added documentation for repl commands and extensions

* added documentation on MCP use, added Chrome example

* added missing step in OSX installation
2025-10-29 14:44:59 +01:00
Francesco Balassone cd956813f0
Extended CAIBench README (#311)
* add preliminar files

* add preliminar files

* cai pro foot note

* cadd cyber PII info

* Update monolithsentinel image reference in README

* add ciberPII-bench

* Document Attack-Defense CTF framework in README

Added detailed section on Attack-Defense CTF including game structure, rules, scoring, architecture, and technical features.

* Update benchmarks/README.md

* Update README with Plot skeletons

* Added plots

* Update benchmark plots in README.md

* Added titles

* Add files via upload

* Add files via upload

* Update navigation in mkdocs.yml

---------

Co-authored-by: Maria <maria@aliasrobotics.com>
Co-authored-by: Víctor Mayoral Vilches <v.mayoralv@gmail.com>
2025-10-28 14:38:07 +01:00
danielsanchezprieto01 6498ade7da
Add TUI documentation (index + getting started) (#313)
* 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
2025-10-27 12:05:16 +01:00
yuri-alias 3ca769c577
Added documentation section on MCP use (#305)
* added documentation for repl commands and extensions

* added documentation on MCP use, added Chrome example
2025-10-22 14:46:48 +02:00
yuri-alias 4c9e453f6c
added documentation for repl commands and extensions (#300) 2025-10-22 10:21:22 +02:00
danielsanchezprieto01 b1ce567f3a
Expansion of `agents.md` with detailed documentation for all available agents, usage guides, and best practices. (#299)
* 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
2025-10-21 16:15:22 +02:00
Javier Garcia c494f95664 docs: Azure OpenAI update; create 'Providers' section in mkdocs.yml and specify configuration for CAI to work correctly (#264) (#273)
docs: Azure OpenAI update; create 'Providers' section in mkdocs.yml and specify configuration for CAI to work correctly (aliasrobotics/cai#264)
2025-09-17 11:17:27 +02:00
Víctor Mayoral Vilches 16c7367de2 Update docs including guardrails
Signed-off-by: Víctor Mayoral Vilches <v.mayoralv@gmail.com>
2025-08-29 14:01:42 +00:00
Víctor Mayoral Vilches bfb1281096 Prompt injection mitigation (#249)
* Reproduce prompt injection flaw in CAI

Signed-off-by: Víctor Mayoral Vilches <v.mayoralv@gmail.com>

* Mitigate prompt injection

Signed-off-by: Víctor Mayoral Vilches <v.mayoralv@gmail.com>

* Add a second PoC, refactor and propose a message when guardrails are triggered

Signed-off-by: Víctor Mayoral Vilches <v.mayoralv@gmail.com>

* Add CAI_GUARDRAILS and 2 additional PoCs

Signed-off-by: Víctor Mayoral Vilches <v.mayoralv@gmail.com>

* Mitigate PoC 3

Signed-off-by: Víctor Mayoral Vilches <v.mayoralv@gmail.com>

* Mitigate PoC 4

Signed-off-by: Víctor Mayoral Vilches <v.mayoralv@gmail.com>

* Add and mitigate PoCs 5 and 6

Signed-off-by: Víctor Mayoral Vilches <v.mayoralv@gmail.com>

* Add PoCs 7 to 10

Signed-off-by: Víctor Mayoral Vilches <v.mayoralv@gmail.com>

* Test and mitigate PoCs 7 to 10

Signed-off-by: Víctor Mayoral Vilches <v.mayoralv@gmail.com>

* Add PoCs 11 to 14

Inspired by 'Embrade The Red' research and also by 'The Month of AI bugs'

Signed-off-by: Víctor Mayoral Vilches <v.mayoralv@gmail.com>

* Mitigate PoCs 11 to 14

Signed-off-by: Víctor Mayoral Vilches <v.mayoralv@gmail.com>

---------

Signed-off-by: Víctor Mayoral Vilches <v.mayoralv@gmail.com>
2025-08-28 20:25:24 +02:00
Víctor Mayoral Vilches f2902cfcac Contribute CAI Fluency first bits
Signed-off-by: Víctor Mayoral Vilches <v.mayoralv@gmail.com>
2025-07-03 16:00:36 +02:00
Mery-Sanz 2c11ed9e1c add faq license 2025-06-18 08:28:34 +00:00
Víctor Mayoral Vilches 04359a07f3 Revert "Apply code formatting with make format" 2025-06-14 09:51:19 +00:00
Víctor Mayoral Vilches 7ec3f59db6 Update doc's index
Signed-off-by: Víctor Mayoral Vilches <v.mayoralv@gmail.com>
2025-06-03 06:58:40 +00:00
Víctor Mayoral Vilches 4926d91048 Update CAI's docs with case studies
Signed-off-by: Víctor Mayoral Vilches <v.mayoralv@gmail.com>
2025-06-03 06:58:27 +00:00
Víctor Mayoral Vilches 912ce4cb4d switch to .3 for 0.4.0 to avoid conflicts
Signed-off-by: Víctor Mayoral Vilches <v.mayoralv@gmail.com>
2025-05-26 10:58:49 +02:00
Víctor Mayoral Vilches 51abd1348e Add some bits to docs
Signed-off-by: Víctor Mayoral Vilches <v.mayoralv@gmail.com>
2025-05-14 14:44:23 +02:00
Mery-Sanz 9991b89af5 add tree 2025-05-14 13:40:25 +02:00
lidia9 3844dc57ae modifs 2025-05-14 13:37:20 +02:00
Mery-Sanz 9ecd81b4e9 update /load 2025-05-14 13:16:37 +02:00
Mery-Sanz b3458a3fa0 tree 2025-05-14 13:00:23 +02:00
lidia9 f4d83f1a15 modifs 2025-05-14 12:59:21 +02:00
Mery-Sanz 7690f9a942 add patterns 2025-05-14 12:37:39 +02:00
lidia9 bdb67e3faa modifs 2025-05-14 12:19:51 +02:00
Mery-Sanz 30f3b40e60 review doc 2025-05-14 12:14:33 +02:00
lidia9 465e9d3605 modif 2025-05-14 12:11:23 +02:00
Mery-Sanz a28dd413af Merge branch 'docs_new' of https://gitlab.com/aliasrobotics/alias_research/cai into docs_new 2025-05-14 12:06:17 +02:00
Mery-Sanz ea3cf8bcaf tools api 2025-05-14 12:06:08 +02:00