* 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
This pull request introduces functionality for visualizing agent
structures using Graphviz. The changes include adding a new dependency,
implementing functions to generate and draw graphs, and adding tests for
these functions.
New functionality for visualizing agent structures:
* Added `graphviz` as a new dependency in `pyproject.toml`.
* Implemented functions in `src/agents/visualizations.py` to generate
and draw graphs for agents using Graphviz. These functions include
`get_main_graph`, `get_all_nodes`, `get_all_edges`, and `draw_graph`.
Testing the new visualization functionality:
* Added tests in `tests/test_visualizations.py` to verify the
correctness of the graph generation and drawing functions. The tests
cover `get_main_graph`, `get_all_nodes`, `get_all_edges`, and
`draw_graph`.
For example, given the following code:
```python
from agents import Agent, function_tool
from agents.visualizations import draw_graph
@function_tool
def get_weather(city: str) -> str:
return f"The weather in {city} is sunny."
spanish_agent = Agent(
name="Spanish agent",
instructions="You only speak Spanish.",
)
english_agent = Agent(
name="English agent",
instructions="You only speak English",
)
triage_agent = Agent(
name="Triage agent",
instructions="Handoff to the appropriate agent based on the language of the request.",
handoffs=[spanish_agent, english_agent],
tools=[get_weather],
)
draw_graph(triage_agent)
```
Generates the following image:
<img width="614" alt="Screenshot 2025-03-13 at 18 36 23"
src="https://github.com/user-attachments/assets/d01fe502-6886-4efb-aaf8-c92e4524b0fe"
/>