Skip to content

docs: fix a2a skill setup and binary naming #45

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

Closed
Math1987 wants to merge 1 commit into from
Closed

docs: fix a2a skill setup and binary naming #45

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
12 changes: 10 additions & 2 deletions skills/a2a-cli/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,12 +13,20 @@ It is one file, `SKILL.md`. Once it is installed, your agent can:

## Prerequisite

The skill drives the `a2a` binary; it does not install it. Install `a2a` first:
The skill drives the `a2a` binary; it does not install it. With a Go toolchain
matching the repository's `go.mod`, build it from source with the expected name:

```bash
go install github.com/a2aproject/a2a-cli@latest
git clone https://github.com/a2aproject/a2a-cli.git
cd a2a-cli
go build -o a2a .
export PATH="$PWD:$PATH"
```

The PATH change applies to this shell. For future sessions, place the binary in
a directory on your PATH. A plain `go install` names the executable `a2a-cli`,
whereas this skill invokes `a2a`.

Confirm it is on your `PATH`:

```bash
Expand Down
10 changes: 7 additions & 3 deletions skills/a2a-cli/SKILL.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,13 +41,17 @@ returned.

## Setup

Check for the binary; install from source if missing (needs a Go toolchain from
https://go.dev/doc/install); re-run to update:
Check that the binary is available:

```bash
go install github.com/a2aproject/a2a-cli@latest
a2a version
```

If it is missing, ask the user to install it using the
[setup instructions](https://github.com/a2aproject/a2a-cli/blob/main/skills/a2a-cli/README.md#prerequisite),
then retry the check. The binary must be available as `a2a` on PATH; the skill
does not install or update it.

The tool is under active development. Treat `a2a help` and `a2a <command>
--help` as the source of truth for the current commands and flags.

Expand Down
Loading