Commit Graph

1014 Commits

Author SHA1 Message Date
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
Víctor Mayoral Vilches cc539928e2 Update README
Signed-off-by: Víctor Mayoral Vilches <v.mayoralv@gmail.com>
2025-10-31 11:46:47 +00:00
Víctor Mayoral Vilches c5c263950f Add two new papers
Signed-off-by: Víctor Mayoral Vilches <v.mayoralv@gmail.com>
2025-10-31 11:46:41 +00:00
aliasrobotics-support 7a110a56fd
Add retry logic for OpenAI timeout exceptions (#322)
- Catch litellm.Timeout exceptions in run_cai_cli
- Retry up to 3 times with 'continue' prompt
- Prevents complete failure on temporary API timeouts

Co-authored-by: Alfonso Glera <glerapic@gmail.com>
2025-10-30 14:01:16 +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
Mery-Sanz 1bdc0522d7
Fix CAI prompt issue 303 (#306)
Co-authored-by: Maria <maria@aliasrobotics.com>
2025-10-22 16:08:38 +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
Mery-Sanz 560ba79ed8
Add cai_model env variable (#297)
add cai_model env variable

Co-authored-by: Maria <maria@aliasrobotics.com>
2025-10-20 12:28:42 +02:00
Víctor Mayoral Vilches ab7eb44a64 Change PoCs position
Signed-off-by: Víctor Mayoral Vilches <v.mayoralv@gmail.com>
2025-10-16 07:14:24 +00:00
Víctor Mayoral Vilches 27ab409b5b Rework videos for better visualization
Signed-off-by: Víctor Mayoral Vilches <v.mayoralv@gmail.com>
2025-10-16 07:09:18 +00:00
Víctor Mayoral Vilches fc69fa3069 Prototype additions
Signed-off-by: Víctor Mayoral Vilches <v.mayoralv@gmail.com>
2025-10-16 06:37:18 +00:00
Víctor Mayoral Vilches bcbb565926 Enlarge a bit the banner
Signed-off-by: Víctor Mayoral Vilches <v.mayoralv@gmail.com>
2025-10-14 14:32:28 +00:00
Víctor Mayoral Vilches a5f509660c Adjustments in banner
Signed-off-by: Víctor Mayoral Vilches <v.mayoralv@gmail.com>
2025-10-14 09:04:12 +00:00
Víctor Mayoral Vilches 4fa9d85f45 Announcement CAI PRO and alias1 (#294)
* CAI PRO release and alias1 announcement

Signed-off-by: Víctor Mayoral Vilches <v.mayoralv@gmail.com>
2025-10-14 10:42:50 +02:00
Ameer Pornillos 5d892a9267 Added additional prompt injections PoCs 15 and 16 (#276)
* Added prompt injections PoCs

* Mitigate PoCs 15 and 16

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

---------

Signed-off-by: Víctor Mayoral Vilches <v.mayoralv@gmail.com>
Co-authored-by: Víctor Mayoral Vilches <v.mayoralv@gmail.com>
2025-10-08 16:23:59 +02:00
Víctor Mayoral Vilches b7dd5fe8e7 Add badge to README
Signed-off-by: Víctor Mayoral Vilches <v.mayoralv@gmail.com>
2025-10-07 06:59:24 +02:00
Rohit Sharma 7db6a6f035 Fix typo (#283) 2025-09-28 14:48:20 +09:00
luijait 82cc20e542 Add support for Chrome MCP (#279) 2025-09-25 07:10:04 +09:00
Víctor Mayoral Vilches 833c6ed858 Update README again
Signed-off-by: Víctor Mayoral Vilches <v.mayoralv@gmail.com>
2025-09-21 05:25:17 +02:00
Víctor Mayoral Vilches 844d518529 Include new humanoids papers
Signed-off-by: Víctor Mayoral Vilches <v.mayoralv@gmail.com>
2025-09-21 05:25:02 +02:00
Víctor Mayoral Vilches 1baf1203c8 Add irregular
Signed-off-by: Víctor Mayoral Vilches <v.mayoralv@gmail.com>
2025-09-20 09:19:07 +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
top9th 46c25e7f17 Fix Google Gemini OpenAI compatibility issues (#268)
Gemini is ready to use with this configuration.
```
OPENAI_API_KEY="gemini_key"
OPENAI_BASE_URL="gemini_openai_compatible_url"
CAI_MODEL=openai/gemini-2.5-pro
```
2025-09-16 07:12:50 +02:00
aFrogThatExists 6a1fd59fbd Updated README.md to add note on installing python3.12-venv (#271)
* Update README.md to add note on installing python3.12-venv

* Updated README.md to move the note to FAQ
2025-09-15 16:18:28 +02:00
Jonas 019c39e563 Fix link in README.md for tools section (#272) 2025-09-15 16:12:39 +02:00
Víctor Mayoral Vilches 79f92fd0ee Address #262
Signed-off-by: Víctor Mayoral Vilches <v.mayoralv@gmail.com>
2025-09-06 16:24:02 +02:00
Víctor Mayoral Vilches 07a6da0bac Add sola and minor correction
Signed-off-by: Víctor Mayoral Vilches <v.mayoralv@gmail.com>
2025-09-05 16:53:06 +02:00
Víctor Mayoral Vilches 2af7319795 Add updates with latest research contribution
Signed-off-by: Víctor Mayoral Vilches <v.mayoralv@gmail.com>
2025-09-01 15:46:39 +02:00
Víctor Mayoral Vilches 340aa77248 Re-iterate errors and release v0.5.5
Signed-off-by: Víctor Mayoral Vilches <v.mayoralv@gmail.com>
2025-08-29 14:09:53 +00:00
Víctor Mayoral Vilches 336617a539 Update README and release v0.5.4
Signed-off-by: Víctor Mayoral Vilches <v.mayoralv@gmail.com>
2025-08-29 14:01:59 +00: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 89aa15999d Minor update in prompt injection PoCs
Signed-off-by: Víctor Mayoral Vilches <v.mayoralv@gmail.com>
2025-08-29 13:54:36 +00:00
luijait 82d0121bd8 async sessions + friendly IDs + tolerant session commands (#253)
* Manual port: async sessions + friendly IDs + tolerant session commands over origin/main; add tests for interactive sessions; no push

* Add guardrail tests

---------

Co-authored-by: System Administrator <root@MacBook-Air-de-luijait.local>
2025-08-29 15:34:48 +02: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 4a0918dc4a Add headers to README
Signed-off-by: Víctor Mayoral Vilches <v.mayoralv@gmail.com>
2025-08-25 13:29:40 +02:00
Víctor Mayoral Vilches f005b3f7ba Various refinements in README
Signed-off-by: Víctor Mayoral Vilches <v.mayoralv@gmail.com>
2025-08-22 04:54:34 +00:00
Víctor Mayoral Vilches c1c4d87341 Add CAI Fluency tech report to README
Signed-off-by: Víctor Mayoral Vilches <v.mayoralv@gmail.com>
2025-08-20 16:04:25 +02:00
Víctor Mayoral Vilches 0a1b5032ad Add the CAI Fluency paper
Signed-off-by: Víctor Mayoral Vilches <v.mayoralv@gmail.com>
2025-08-20 16:03:03 +02:00
Víctor Mayoral Vilches 145a030826 Update badge until pystats gets fixed
Signed-off-by: Víctor Mayoral Vilches <v.mayoralv@gmail.com>
2025-08-19 13:28:37 +02:00
Víctor Mayoral Vilches 02249dae79 Improve readibility
Signed-off-by: Víctor Mayoral Vilches <v.mayoralv@gmail.com>
2025-08-18 09:38:10 +02:00
Víctor Mayoral Vilches 148fe87714 Add further visibility to case studies
Signed-off-by: Víctor Mayoral Vilches <v.mayoralv@gmail.com>
2025-08-18 08:12:07 +02:00
Víctor Mayoral Vilches e8f89c7f95 Merge branch 'main' of https://github.com/aliasrobotics/cai 2025-08-18 08:07:00 +02:00