Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
31 changes: 17 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,22 +15,25 @@ The recommended way to install Zero is to let your agent install it and guide
you through setup. Just paste this to your agent:

```
Help me install Zero (zero.xyz) in this agent. Zero is an agent plugin — a CLI,
a skill, hooks, and an MCP connector — that lets you find, invoke, and pay for
thousands of external capabilities. The skill teaches you how to use the CLI,
the hooks remind you to reach for it when a task is beyond your built-in
abilities, and the MCP connector is how clients without a shell (web/mobile)
sign in. I understand it adds a skill, hooks, and an MCP connector to my agent
config, plus a small CLI runtime under ~/.zero — that's what I want.

Fetch the install runbook using curl at https://www.zero.xyz/install.md and read
it. Tell me briefly what the setup will do, then go ahead: use this harness's
plugin manager if the runbook lists one, run the commands in my shell, and
narrate as you go. I'll approve the browser sign-in when you show me the link.
Don't add funds or buy anything — that's a separate step I'll do later if I
want. If anything seems off, stop and ask.
Help me set up Zero — a tool that lets you find and use extra services you
don't have built in (image/video generation, search live social media, or
hosting a free webpage). It's free to set up.

Set it up by running the Zero CLI's setup (needs Node.js — install it first if
`npm` isn't available):

npm i -g @zeroxyz/cli
zero init
zero auth login
```

This is the same prompt [zero.xyz](https://www.zero.xyz/setup.md) hands out:
the CLI is a public npm package your agent can inspect
([`@zeroxyz/cli`](https://www.npmjs.com/package/@zeroxyz/cli)), and
`zero init` integrates the skill and hooks with every harness it detects —
[What the plugin does](#what-the-plugin-does) lists exactly what that adds.
`zero uninstall` reverses all of it.

If you prefer to set up Zero manually, or your agent had issues with the
installation, use the guides below. Pick your agent:

Expand Down
17 changes: 11 additions & 6 deletions guides/agent-install.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,21 +9,26 @@ packaging and this runbook are maintained at

## Install

Pick whichever applies:
The default path is npm — it works in any harness with Node.js:

| Environment | Command |
|---|---|
| Anything with npm (default) | `npm i -g @zeroxyz/cli && zero init` |
| Claude Code | `claude plugin marketplace add officialzeroxyz/zero-plugins && claude plugin install zero@zero-plugins` |
| Codex | `codex plugin marketplace add officialzeroxyz/zero-plugins && codex plugin add zero@zero-plugins` |
| Gemini CLI | `gemini extensions install https://github.com/officialzeroxyz/zero-plugins` |
| Anything with npm | `npm i -g @zeroxyz/cli && zero init` |
| Claude Chat (claude.ai) / Claude Cowork | no shell — follow [zero.xyz/install/claude.md](https://www.zero.xyz/install/claude.md) instead |
| None of the above | see [Fallback installer](#fallback-installer) |

The first three rows install through that harness's own plugin manager: they
add the zero-plugins repo as a source, then install the Zero plugin from it
via the manager's normal review-and-consent flow. The plugin's full contents
are listed below. The npm and fallback rows end by running `zero init`.
The npm row installs the CLI from the public
[`@zeroxyz/cli`](https://www.npmjs.com/package/@zeroxyz/cli) package (inspect
it with `npm view @zeroxyz/cli`), then `zero init` integrates the skill and
hooks with every harness it detects. The Claude Code, Codex, and Gemini CLI
rows are per-harness alternatives that install through that harness's own
plugin manager: they add the zero-plugins repo as a source, then install the
Zero plugin from it via the manager's normal review-and-consent flow. The
plugin's full contents are listed below. The npm and fallback rows end by
running `zero init`.

## What the plugin installs

Expand Down