Commit Graph

137 Commits

Author SHA1 Message Date
Daniel Sanchez f381b696ed docs: add terminals_management.md with multi-terminal workflows and layouts 2025-10-28 11:13:37 +01:00
Daniel Sanchez fb54d2abca docs: activate links for completed TUI documentation files 2025-10-27 16:56:02 +01:00
Daniel Sanchez cb5c238ef6 docs: update commands_reference with enhanced agent list, terminal targeting methods, and UI refinements 2025-10-27 16:48:38 +01:00
Daniel Sanchez 93511d8823 docs: add comprehensive commands reference for TUI 2025-10-27 16:33:47 +01:00
Daniel Sanchez 41aef73500 docs: rename files to use underscores for consistency (keyboard_shortcuts, user_interface) 2025-10-27 16:14:02 +01:00
Daniel Sanchez cb41ad1722 Restructure 2025-10-27 15:59:45 +01:00
Daniel Sanchez 9fa18deb01 docs: add comprehensive keyboard shortcuts reference for TUI 2025-10-27 15:45:59 +01:00
Daniel Sanchez 57e16973fd docs: update user-interface content 2025-10-27 15:39:31 +01:00
Daniel Sanchez dd2255d3df Minimal changes 2025-10-27 15:31:48 +01:00
Daniel Sanchez 860447b9c7 docs: improve TUI user-interface with enhanced topbar descriptions, layout screenshots, and reorganized command palette 2025-10-27 15:28:31 +01:00
Daniel Sanchez 16983f2d44 docs: add comprehensive TUI user interface documentation 2025-10-27 12:47:02 +01:00
Daniel Sanchez 5b25cd6cf8 docs: add CAI-Pro exclusive banner to TUI documentation 2025-10-27 11:56:03 +01:00
Daniel Sanchez 456bee795f 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
2025-10-24 14:38:00 +02:00
Daniel Sanchez b98995e9b6 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
2025-10-24 14:17:42 +02:00
Daniel Sanchez 2e8d5dabc2 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
2025-10-24 14:12:46 +02:00
Daniel Sanchez 47e73c1985 docs: minimum change 2025-10-24 14:09:42 +02:00
Daniel Sanchez 29213ed3a8 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
2025-10-24 14:06:44 +02:00
Daniel Sanchez f772b28326 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
2025-10-24 13:56:37 +02:00
Daniel Sanchez b7f5291c1b docs: add TUI main interface screenshot
- Add cai-tui-main.png screenshot to docs/media/
- Screenshot shows TUI interface for documentation
2025-10-24 13:04:20 +02:00
Daniel Sanchez 5ce409f7ea 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
2025-10-24 12:40:55 +02: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
lidia9 007a989137 dev 2025-05-14 12:05:30 +02:00
lidia9 87538793d4 modifs 2025-05-14 11:59:02 +02:00
lidia9 00671adacd modifs 2025-05-14 11:56:27 +02:00
Mery-Sanz 38c0d3c9cc restructure 2025-05-14 11:25:55 +02:00
Mery-Sanz 97f67c88cd new brnach 2025-05-14 11:18:48 +02:00
Víctor Mayoral Vilches 56479c5a01 Add minor updates in docs
Signed-off-by: Víctor Mayoral Vilches <v.mayoralv@gmail.com>
2025-05-12 11:48:24 +02:00