Agent Sandbox Registry

agent-sandbox

Agent Skill Installation & Distribution

docs/en/guide/agent-skill-installation.md

Agent Skill Installation & Distribution

This guide explains how to bring the Agent Sandbox Agent Skill (SKILL.md, repository root) into your AI coding tool — Qoder, Claude Code, Cursor, Qwen Code, Codex, and any other skills-aware tool — before the abx CLI or the Python SDK is installed.

The skill is plain text (YAML frontmatter + Markdown instructions). Installing it adds no runtime to this repository, no registry to the CLI, and nothing that executes on its own. It simply teaches an agent how to operate Agent Sandbox once you are ready.

How these commands were verified: every command, option, and directory in this guide was checked on 2026-09-29 against real --help output or vendor documentation (sources at the end). The Agent Skills ecosystem has no single cross-tool installation command — where tools differ, this guide lists each verified option instead of inventing one.


1. Skill first, SDK second

The skill and the abx / SDK installation are deliberately decoupled:

  1. Install the skill into your tool (this guide). No Python required.
  2. Install the package when the agent (or you) is ready to actually run sandboxes: npm install -g @agent-sandbox/cli — see section 7.
  3. Configure credentials (abx config set sandbox_api_key …, or AK/SK).
  4. Pick an interface — MCP for chat agents, CLI for scripts, SDK for Python code (see SKILL.md → "Choosing an interface").

The agent reads the skill's instructions and drives steps 2–4 itself; nothing in step 1 depends on them.


2. Where each tool looks for skills (verified)

A skill is a directory containing a SKILL.md file (agent-sandbox/SKILL.md). Every tool below loads the same frontmatter format:

Tool User-level (all projects) Project-level (this repository) Verified source
Qoder ~/.qoder/skills/agent-sandbox/SKILL.md <project>/.qoder/skills/agent-sandbox/SKILL.md Qoder docs — IDE skills, CLI skills
Claude Code ~/.claude/skills/agent-sandbox/SKILL.md <project>/.claude/skills/agent-sandbox/SKILL.md Claude Code skills
Cursor ~/.cursor/skills/agent-sandbox/SKILL.md or ~/.agents/skills/agent-sandbox/SKILL.md <project>/.cursor/skills/agent-sandbox/SKILL.md or <project>/.agents/skills/agent-sandbox/SKILL.md Cursor skills
Qwen Code ~/.qwen/skills/agent-sandbox/SKILL.md <project>/.qwen/skills/agent-sandbox/SKILL.md Qwen Code skills
Codex $HOME/.agents/skills/agent-sandbox/SKILL.md <repo-root>/.agents/skills/agent-sandbox/SKILL.md (scanned from the current directory up to the repo root) Codex skills

Notes verified in the same sources:

If a tool is missing from this table (Gemini CLI, GitHub Copilot, Windsurf, …), consult the tool's own documentation — the formats are compatible, but directory names differ.


3. Option A — the skills CLI (npx skills add)

The skills CLI (npm package skills, v1.7.0 at verification time) installs Agent Skills into the directories from section 2, for many tools at once.

Preview first (changes nothing on disk)

npx skills add agent-sandbox/agent-sandbox --list

Install

# One agent, project scope (default), non-interactive:
npx skills add agent-sandbox/agent-sandbox --skill agent-sandbox -a qoder -y

# The same skill to several agents at once:
npx skills add agent-sandbox/agent-sandbox --skill agent-sandbox \
  -a qoder -a claude-code -a cursor -a qwen-code -y

# User-level instead of project-level:
npx skills add agent-sandbox/agent-sandbox --skill agent-sandbox -a qoder -g -y

--agent names (from npx skills --help and the CLI README): qoder, qoder-cn, claude-code, cursor, qwen-code, codex; use '*' for every detected agent.

Options (real --help output)

Option Meaning
-g, --global Install to the user-level directory instead of the project
-a, --agent <agents> Target specific agents ('*' = all)
-s, --skill <skills> Install only the named skills ('*' = all skills in the repo)
-l, --list List available skills without installing
-y, --yes Skip all confirmation prompts (CI-friendly)
--copy Copy files instead of the default symlink/copy handling
--all Shorthand for --skill '*' --agent '*' -y

Where files land (observed)

Project-scope installs write <project>/<agent-dir>/skills/agent-sandbox/ (for example .qoder/skills/agent-sandbox/) and record the install in a skills-lock.json at the project root:

{
  "version": 1,
  "skills": {
    "agent-sandbox": {
      "source": "…",
      "sourceType": "…",
      "computedHash": "…"
    }
  }
}

Commit skills-lock.json alongside the skill so teammates and CI can restore the exact install with npx skills experimental_install.

Two caveats specific to this repository

Update / list / remove

npx skills list                                   # show installed skills
npx skills update agent-sandbox -y                 # update (auto-detects scope)
npx skills update -g                              # only user-level skills
npx skills remove agent-sandbox                    # remove from project scope
npx skills remove agent-sandbox -g                 # remove from user scope

Requires Node.js (npx). If you do not want to run Node tooling, use one of the next two options.


4. Option B — copy or download the single file

SKILL.md is one self-contained file; a manual copy is a fully supported install.

  1. Open https://github.com/alibaba-agent-sandbox/agent-sandbox/blob/main/SKILL.md and use Raw / Download, then place the file as agent-sandbox/SKILL.md under the directory for your tool (section 2). For example:

bash mkdir -p ~/.qoder/skills/agent-sandbox # save the downloaded file as: # ~/.qoder/skills/agent-sandbox/SKILL.md

  1. Or download directly with curl — a single file, never piped into a shell:

bash mkdir -p ~/.claude/skills/agent-sandbox curl -fsSL "https://raw.githubusercontent.com/agent-sandbox/agent-sandbox/<TAG-OR-COMMIT>/SKILL.md" \ -o ~/.claude/skills/agent-sandbox/SKILL.md

Replace <TAG-OR-COMMIT> with a release tag or a full commit SHA. Avoid a moving branch (main) when you need a reproducible version.

  1. Verify what you downloaded before the agent uses it:

bash head -n 3 ~/.claude/skills/agent-sandbox/SKILL.md # must start with "---" grep -m1 '^name: agent-sandbox$' ~/.claude/skills/agent-sandbox/SKILL.md shasum -a 256 ~/.claude/skills/agent-sandbox/SKILL.md # record/compare the hash

This project does not recommend curl … | sh-style pipelines — download to a file, inspect it, then install.

Reloading after a manual install

Tool How it picks up the new skill
Qoder /skills reload in a running CLI session, or restart the IDE
Claude Code Loaded automatically in new sessions (personal/project skill dirs)
Cursor Restart, or Developer: Reload Window
Qwen Code Personal/project skill directories are watched; restart in bare mode
Codex Skill changes are detected automatically; restart if an update does not appear

5. Option C — git clone / sparse checkout

Use Git when you want the file to come from a tracked, verifiable revision.

Full clone (then copy just the skill folder you need):

git clone https://github.com/alibaba-agent-sandbox/agent-sandbox.git
mkdir -p ~/.qwen/skills/agent-sandbox
cp cli/SKILL.md ~/.qwen/skills/agent-sandbox/SKILL.md

Sparse checkout (only SKILL.md, no other repository content):

git clone --depth 1 --filter=blob:none --sparse \
  https://github.com/alibaba-agent-sandbox/agent-sandbox.git
cd cli
git sparse-checkout set --no-cone /SKILL.md

Pin a version at any point with git checkout <TAG-OR-COMMIT>; the sparse working tree follows the checkout, so re-copying SKILL.md from a tag gives you that exact revision. Delete the clone directory when you are done.


6. Marketplace and plugin paths (verified, and what they are not)

Plugin marketplaces distribute bundles; Agent Sandbox currently publishes no plugin bundle (the repository contains no .claude-plugin/ or .cursor-plugin/ manifest). For a single skill, options A–C above are the working paths. The marketplace mechanics below are documented for completeness and for future plugin packaging:

If a marketplace listing for Agent Sandbox appears later, prefer it only after checking this repository's release notes.


7. After the skill: install @agent-sandbox/cli, configure credentials, choose an interface

The skills guide the agent loads (SKILL.md) contains the operational details; the summary:

# 1. Install the package (CLI + MCP STDIO server; requires Node.js 20+)
npm install -g @agent-sandbox/cli

# If npm reports no matching version (no public npm release was
# available at the time of writing — check with the command below), install
# from source instead:
npm view @agent-sandbox/cli versions
git clone https://github.com/alibaba-agent-sandbox/agent-sandbox.git && cd cli
npm ci && npm run build && npm install -g .

# 2. Verify
abx --version

# 3. Configure credentials (stored in ~/.abx/.env, masked on display)
abx config set sandbox_api_key <YOUR_API_KEY>
abx config set region cn-hangzhou

# 4. Choose an interface
abx mcp install --target cursor   # MCP for chat agents (or --target claude / vscode)
abx exec <sandbox-id> "echo hi"   # CLI for scripts

8. Version pinning, updates, uninstall

Method Pin a version Update Uninstall
skills CLI skills-lock.json (records source + content hash; restore with npx skills experimental_install) npx skills update agent-sandbox -g / -p npx skills remove agent-sandbox [-g]
Manual copy Download from a tag/commit raw URL Repeat the download, overwrite the file Delete the agent-sandbox/ skill folder
Git clone / sparse git checkout <TAG-OR-COMMIT> git fetch + checkout, then re-copy Delete the clone and the installed skill folder

Uninstall means removing exactly one folder — for example ~/.qoder/skills/agent-sandbox/ — then reloading the tool. Do not delete the shared skills/ parent directory: other skills live there.


9. Security notes and third-party boundaries

  1. A skill is instructions for an agent running with your privileges. Read SKILL.md before installing; prefer the official repository URL. The skills CLI itself prints "Review skills before use; they run with full agent permissions."
  2. Local-path installs copy ignored files (.env, caches). Never install from a local working tree that contains credentials (section 3).
  3. Credential hygiene: the skill never asks you to print keys. It instructs agents to use masked commands (abx config get sandbox_api_key) and to store credentials in ~/.abx/.env. Do not commit ~/.abx/.env, and rotate any key that has appeared in output or a transcript.
  4. No curl | sh: download single files to disk, pin a tag/commit, verify the frontmatter and hash before use (section 4).
  5. Third-party code boundary: marketplace plugins are third-party code with different review levels (Claude: official / community / third-party marketplace tiers; Cursor: every marketplace plugin is manually reviewed and must be open source; cursor.directory and registry listings are community). A skill folder may contain scripts/ that the agent can run — treat those as code you are choosing to execute.

Sources (verified 2026-09-29)