Skip to content

Commit b15b580

Browse files
dgageotdgageot
committed
Improve docs
Signed-off-by: David Gageot <david.gageot@docker.com>
1 parent 35f3337 commit b15b580

5 files changed

Lines changed: 23 additions & 26 deletions

File tree

‎CLAUDE.md‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,6 @@ This file provides guidance to Claude Code (claude.ai/code) when working with co
2121

2222
- `./bin/cagent run <config.yaml>` - Run agent with configuration
2323
- `./bin/cagent run <config.yaml> -a <agent_name>` - Run specific agent
24-
- `./bin/cagent tui <config.yaml>` - Start TUI interface
2524
- `./bin/cagent mcp server --port 8080 --path /mcp --agents-dir <config_dir>` - Start MCP server mode
2625
- `./bin/cagent init` - Initialize new project
2726

‎docs/USAGE.md‎

Lines changed: 13 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
# Usage and configuration
22

3-
This guide will help you get started with cagent and learn how to use its
3+
This guide will help you get started with `cagent` and learn how to use its
44
powerful multi-agent system to accomplish various tasks.
55

66
## What is cagent?
77

8-
cagent is a powerful, customizable multi-agent system that orchestrates AI
8+
`cagent` is a powerful, customizable multi-agent system that orchestrates AI
99
agents with specialized capabilities and tools. It features:
1010

1111
- **🏗️ Multi-tenant architecture** with client isolation and session management
@@ -35,27 +35,24 @@ We really think we're getting somewhere as we build out the primitives of `cagen
3535
cagent provides multiple interfaces and deployment modes:
3636

3737
```bash
38-
# Interactive CLI mode
39-
$ ./bin/cagent run config.yaml
40-
$ ./bin/cagent run config.yaml -a agent_name # Run specific agent
41-
$ ./bin/cagent run config.yaml --debug # Enable debug logging
42-
4338
# Terminal UI
44-
$ ./bin/cagent tui config.yaml
39+
$ cagent run config.yaml
40+
$ cagent run config.yaml -a agent_name # Run specific agent
41+
$ cagent run config.yaml --debug # Enable debug logging
4542

4643
# MCP Server Mode (for external clients like Claude Code)
47-
$ ./bin/cagent mcp server --agents-dir ./config_directory
48-
$ ./bin/cagent mcp server --port 8080 --path /mcp --agents-dir ./config
44+
$ cagent mcp server --agents-dir ./config_directory
45+
$ cagent mcp server --port 8080 --path /mcp --agents-dir ./config
4946

5047
# API Server (HTTP REST API)
51-
$ ./bin/cagent api config.yaml
52-
$ ./bin/cagent api config.yaml --port 8080
48+
$ cagent api config.yaml
49+
$ cagent api config.yaml --port 8080
5350

5451
# Project Management
55-
$ ./bin/cagent new # Initialize new project
56-
$ ./bin/cagent eval config.yaml # Run evaluations
57-
$ ./bin/cagent pull docker.io/user/agent # Pull agent from registry
58-
$ ./bin/cagent push docker.io/user/agent # Push agent to registry
52+
$ cagent new # Initialize new project
53+
$ cagent eval config.yaml # Run evaluations
54+
$ cagent pull docker.io/user/agent # Pull agent from registry
55+
$ cagent push docker.io/user/agent # Push agent to registry
5956
```
6057

6158
### Interface-Specific Features

‎docs/architecture.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
# Architecture Guide
22

3-
This guide explains the internal architecture of cagent, how components
3+
This guide explains the internal architecture of `cagent`, how components
44
interact, and the design principles behind the system.
55

66
## System Overview
77

8-
cagent is built as a modular, event-driven multi-agent system with the following
8+
`cagent` is built as a modular, event-driven multi-agent system with the following
99
key characteristics:
1010

1111
- **Multi-tenant Architecture**: ServiceCore layer provides client isolation for MCP and HTTP transports

‎examples/README.md‎

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,16 @@
22

33
## **Basic Configurations**
44

5-
These examples are fairly basic and show you the YAML syntax for writing an agent.
6-
Some of these agents use [Built-in Tools](https://github.com/docker/cagent?tab=readme-ov-file#tool-configuration) like filesystem (which grants filesystem access) or memory (which allows the agent to store its findings for later use).
5+
These examples are fairly basic and show you the YAML syntax for writing agents.
6+
7+
Some of these agents use [built-in tools](../docs/USAGE.md#tool-configuration)
8+
like `filesystem`, which grants filesystem access, or `memory`, to allow the agent to store its findings for later use.
79

810
| Name | Description/Purpose | Filesystem | Shell | Todo | Think | Memory | MCP Servers | Sub-agents |
911
|----------------------------------------|----------------------------------------|------------|-------|------|-------|--------|-------------|------------|
1012
| [echo-agent.yaml](echo-agent.yaml) | Simple echo agent | | | | | | | |
1113
| [pirate.yaml](pirate.yaml) | Pirate-themed assistant | | | | | | | |
12-
| [haiku.yaml](haiku.yaml) | Write Haikus | | | | | | | |
14+
| [haiku.yaml](haiku.yaml) | Writes Haikus | | | | | | | |
1315
| [42.yaml](42.yaml) | Douglas Adams-style witty AI assistant | | | | | | | |
1416
| [contradict.yaml](contradict.yaml) | Contrarian viewpoint provider | | | | | | | |
1517
| [silvia.yaml](silvia.yaml) | Sylvia Plath-inspired poetic AI | | | | | | | |
@@ -37,7 +39,7 @@ These are more advanced examples, most of them involve some sort of MCP server t
3739
| [moby.yaml](moby.yaml) | Moby Project Expert | | | | | | `gitmcp.io/moby/moby` | |
3840
| [image_text_extractor.yaml](image_text_extractor.yaml) | Image text extraction | ✓ | | | | | | |
3941
| [doc_generator.yaml](doc_generator.yaml) | Documentation generation from codebases | | ✓ | | ✓ | | | |
40-
| [mcp_generator.yaml](mcp_generator.yaml) | Generates MCP configurations | | | | | | docker,[duckduckgo-mcp-server](https://hub.docker.com/mcp/server/duckduckgo/overview) | |
42+
| [mcp_generator.yaml](mcp_generator.yaml) | Generates MCP configurations | | | | | | docker,[duckduckgo](https://hub.docker.com/mcp/server/duckduckgo/overview) | |
4143

4244
## **Multi-Agent Configurations**
4345

@@ -46,9 +48,9 @@ A coordinator agent usually makes them work together and checks that the work is
4648

4749
| Name | Description/Purpose | Filesystem | Shell | Todo | Think | Memory | MCP Servers | Sub-agents |
4850
|--------------------------------------|-----------------------------------------|------------|-------|------|-------|--------|--------------------------------------------------------------------------------|------------|
49-
| [blog.yaml](blog.yaml) | Technical blog writing workflow | | | | ✓ | | [duckduckgo-mcp-server](https://hub.docker.com/mcp/server/duckduckgo/overview) | ✓ |
51+
| [blog.yaml](blog.yaml) | Technical blog writing workflow | | | | ✓ | | [duckduckgo](https://hub.docker.com/mcp/server/duckduckgo/overview) | ✓ |
5052
| [dev-team.yaml](dev-team.yaml) | Development team coordinator | ✓ | ✓ | ✓ | ✓ | ✓ | | ✓ |
5153
| [multi-code.yaml](multi-code.yaml) | Technical lead and project coordination | ✓ | ✓ | ✓ | ✓ | ✓ | | ✓ |
5254
| [writer.yaml](writer.yaml) | Story writing workflow supervisor | | | | ✓ | | | ✓ |
53-
| [finance.yaml](finance.yaml) | Financial research and analysis | | | | ✓ | | [duckduckgo-mcp-server](https://hub.docker.com/mcp/server/duckduckgo/overview) | ✓ |
55+
| [finance.yaml](finance.yaml) | Financial research and analysis | | | | ✓ | | [duckduckgo](https://hub.docker.com/mcp/server/duckduckgo/overview) | ✓ |
5456
| [shared-todo.yaml](shared-todo.yaml) | Shared todo item manager | | | ✓ | | | | ✓ |

‎golang_developer.yaml‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -129,7 +129,6 @@ agents:
129129
You can help users run cagent in various modes:
130130
- `./bin/cagent run <config.yaml>` - Run agent with configuration
131131
- `./bin/cagent run <config.yaml> -a <agent_name>` - Run specific agent
132-
- `./bin/cagent tui <config.yaml>` - Start TUI interface
133132
- `./bin/cagent mcp server --port 8080 --path /mcp --agents-dir <config_dir>` - Start MCP server mode
134133
- `./bin/cagent init` - Initialize new project
135134

0 commit comments

Comments
 (0)