Skip to content

docs(README): add Claude Code plugin install as recommended path #118

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
George-iam merged 2 commits into from
Apr 20, 2026
Merged

docs(README): add Claude Code plugin install as recommended path #118

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e530cd2
docs(README): add Claude Code plugin install as recommended path
George-iam Apr 20, 2026
2d0eed0
docs(README): drop Windows-native claims — not released yet
George-iam Apr 20, 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
24 changes: 23 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,28 @@ Decisions enforce verification requirements: agent must run tests and show proof

**Requires [Claude Code](https://docs.anthropic.com/en/docs/claude-code) (CLI or VS Code extension).**

### Option 1: Claude Code plugin (recommended)

In Claude Code, run:

```
/plugin marketplace add anthropics/claude-plugins-community
/plugin install axme-code@claude-community
```

Or from the terminal:

```bash
claude plugin marketplace add anthropics/claude-plugins-community
claude plugin install axme-code@claude-community
```

The plugin ships with the MCP server, safety hooks, and CLI bundled together; no separate binary to install. On first use in a project, just ask the agent to call `axme_context` — the plugin auto-initializes the knowledge base on that session.

### Option 2: Standalone binary

Install the CLI system-wide (useful if you want to run `axme-code` outside Claude Code, e.g. for scripting):

```bash
curl -fsSL https://raw.githubusercontent.com/AxmeAI/axme-code/main/install.sh | bash
```
Expand All @@ -88,7 +110,7 @@ Installs to `~/.local/bin/axme-code`. Supports Linux and macOS (x64 and ARM64).

**Windows via WSL2** is supported. Install a WSL2 distro (`wsl --install -d Ubuntu-22.04`), then install both Claude Code and axme-code **inside** your WSL distro — not on the Windows host. Native Windows is not yet supported.

### Setup
Then in each project:

```bash
cd your-project # or workspace root for multi-repo
Expand Down