Skip to content

Fix documentation #1983

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
gtardif merged 3 commits into from
Mar 9, 2026
+15 −15
Merged

Fix documentation #1983

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
74af523
Fix documentation
dgageot Mar 8, 2026
650fedb
Fix documentation
dgageot Mar 8, 2026
3896368
Fix documentation
dgageot Mar 8, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/community/troubleshooting/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -164,7 +164,7 @@ When docker-agent as an API server or MCP server, ensure the port is not already
$ lsof -i :8080

# Use a different port
$ docker agent api config.yaml --listen :9090
$ docker agent serve api config.yaml --listen :9090
```

### MCP endpoint accessibility
Expand Down Expand Up @@ -210,7 +210,7 @@ Monitor for tools that don't clean up properly — check debug logs for MCP serv
$ docker pull docker.io/username/agent:latest

# Verify pulled agent content
$ docker agent pull docker.io/username/agent:latest
$ docker agent share pull docker.io/username/agent:latest
```

### Agent content issues
Expand Down
6 changes: 3 additions & 3 deletions docs/concepts/distribution/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,10 +33,10 @@ $ docker agent share push ./agent.yaml ghcr.io/username/my-agent:v1.0

```bash
# Pull an agent
$ docker agent pull docker.io/username/my-agent:latest
$ docker agent share pull docker.io/username/my-agent:latest

# Pull from the agent catalog
$ docker agent pull agentcatalog/pirate
$ docker agent share pull agentcatalog/pirate
```

## Running from a Registry
Expand Down Expand Up @@ -84,7 +84,7 @@ The API server supports OCI references with auto-refresh:

```bash
# Start API from registry, auto-pull every 10 minutes
$ docker agent api docker.io/username/agent:latest --pull-interval 10
$ docker agent serve api docker.io/username/agent:latest --pull-interval 10
```

## Private Repositories
Expand Down
8 changes: 4 additions & 4 deletions docs/features/api-server/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,16 +14,16 @@ The `docker agent serve api` command starts an HTTP server that exposes your age

```bash
# Start the API server
$ docker agent api agent.yaml
$ docker agent serve api agent.yaml

# Custom listen address
$ docker agent api agent.yaml --listen 0.0.0.0:8080
$ docker agent serve api agent.yaml --listen 0.0.0.0:8080

# With session persistence
$ docker agent api agent.yaml --session-db ./sessions.db
$ docker agent serve api agent.yaml --session-db ./sessions.db

# Auto-refresh from OCI registry every 10 minutes
$ docker agent api agentcatalog/coder --pull-interval 10
$ docker agent serve api agentcatalog/coder --pull-interval 10
```

## Endpoints
Expand Down
10 changes: 5 additions & 5 deletions docs/features/cli/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,12 +89,12 @@ $ docker agent new --model dmr/ai/gemma3-qat:12B --max-iterations 15
Start the HTTP API server for programmatic access.

```bash
$ docker agent api [config] [flags]
$ docker agent serve api [config] [flags]

# Examples
$ docker agent api agent.yaml
$ docker agent api agent.yaml --listen :8080
$ docker agent api ociReference --pull-interval 10 # auto-refresh
$ docker agent serve api agent.yaml
$ docker agent serve api agent.yaml --listen :8080
$ docker agent serve api ociReference --pull-interval 10 # auto-refresh
```

### `docker agent serve mcp`
Expand Down Expand Up @@ -137,7 +137,7 @@ $ docker agent serve acp agent.yaml

See [ACP](/features/acp/) for details on the Agent Client Protocol.

### `docker agent share push` / `docker agent pull`
### `docker agent share push` / `docker agent share pull`

Share agents via OCI registries.

Expand Down
2 changes: 1 addition & 1 deletion docs/getting-started/installation/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Install docker-agent using [Homebrew](https://brew.sh/):

```bash
# Install
$ brew install docker/tap/docker-agent
$ brew install cagent

# Verify
$ docker-agent version
Expand Down