Conversation
Signed-off-by: David Gageot <david.gageot@docker.com>
![docker-agent[bot]](https://avatars.githubusercontent.com/in/2787757?s=60&v=4){kind=small}
There was a problem hiding this comment.
Review Summary
Assessment: 🟡 NEEDS ATTENTION
This PR updates the README installation instructions from "copy" to "symlink". While symlinking is technically preferable (especially for package managers), the new instructions are incomplete and could confuse users.
Found 3 medium-severity documentation issues:
- Missing symlink command syntax (
ln -s) - Missing source path information for Homebrew installation
- Incomplete instructions for binary release symlink setup
These gaps may lead to user confusion and installation failures, especially for users unfamiliar with symlinks.
| **Docker Desktop** (4.63+) — docker-agent CLI plugin is pre-installed. Just run `docker agent`. | ||
|
|
||
| **Homebrew** — `brew install docker-agent`. Run `docker-agent` directly or copy the binary in `~/.docker/cli-plugins` and run `docker agent`. | ||
| **Homebrew** — `brew install docker-agent`. Run `docker-agent` directly or symlink the binary to `~/.docker/cli-plugins/docker-agent` and run `docker agent`. |
There was a problem hiding this comment.
ISSUE: Symlink instruction lacks the actual command syntax
The instruction says "symlink the binary to ~/.docker/cli-plugins/docker-agent" but doesn't provide the actual command. Users unfamiliar with symlinks won't know the syntax.
Consider adding the explicit command:
ln -s $(brew --prefix)/bin/docker-agent ~/.docker/cli-plugins/docker-agent| **Docker Desktop** (4.63+) — docker-agent CLI plugin is pre-installed. Just run `docker agent`. | ||
|
|
||
| **Homebrew** — `brew install docker-agent`. Run `docker-agent` directly or copy the binary in `~/.docker/cli-plugins` and run `docker agent`. | ||
| **Homebrew** — `brew install docker-agent`. Run `docker-agent` directly or symlink the binary to `~/.docker/cli-plugins/docker-agent` and run `docker agent`. |
There was a problem hiding this comment.
ISSUE: Missing source path information for Homebrew symlink instruction
The instruction doesn't specify where Homebrew installs the binary. Users need to know the source path (typically $(brew --prefix)/bin/docker-agent or /usr/local/bin/docker-agent) to create a proper symlink.
Consider clarifying the source location in the instructions.
| **Homebrew** — `brew install docker-agent`. Run `docker-agent` directly or symlink the binary to `~/.docker/cli-plugins/docker-agent` and run `docker agent`. | ||
|
|
||
| **Binary releases** — Download from [GitHub Releases](https://github.com/docker/cagent/releases). Copy `docker-agent` binary in `~/.docker/cli-plugins` to be able to use `docker agent`, or use `docker-agent` directly. | ||
| **Binary releases** — Download from [GitHub Releases](https://github.com/docker/cagent/releases). Symlink the `docker-agent` binary to `~/.docker/cli-plugins/docker-agent` to be able to use `docker agent`, or use `docker-agent` directly. |
There was a problem hiding this comment.
ISSUE: Binary release symlink instruction missing source path and command syntax
The instruction says "Symlink the docker-agent binary" but doesn't explain:
- Where to place the downloaded binary initially
- The actual symlink command syntax
Consider providing a complete example:
ln -s /path/to/downloaded/docker-agent ~/.docker/cli-plugins/docker-agent
2 participants
No description provided.