Skip to content

Latest commit

 

History

History
157 lines (112 loc) · 3.82 KB

quickstart.md

File metadata and controls

157 lines (112 loc) · 3.82 KB
summary Start using ClawHub: find, install, update, and publish skills or plugins.
read_when
First time using ClawHub
Installing a skill or plugin from the registry
Publishing to ClawHub

Quickstart

ClawHub is a registry for OpenClaw skills and plugins.

Use OpenClaw when you are installing things into OpenClaw. Use the clawhub CLI when you are signing in, publishing, managing your own listings, or using registry-specific workflows.

Find and install a skill

Search from OpenClaw:

openclaw skills search "calendar"

Install a skill:

openclaw skills install @openclaw/demo

Update installed skills:

openclaw skills update --all

OpenClaw records where the skill came from so later updates can continue to resolve through ClawHub.

Find and install a plugin

Search from OpenClaw:

openclaw plugins search "calendar"

On released OpenClaw versions through 2026.10.4, use an explicit ClawHub source:

openclaw plugins install clawhub:<package>

Update installed plugins:

openclaw plugins update --all

Updated main/dev builds with ClawHub-default support accept the shorter command:

openclaw plugins install @composio/composio

The shorter form is not supported as a ClawHub default by released versions through 2026.11.2. The explicit clawhub:<package> form works on both old and updated builds. Use openclaw plugins install npm:<package> to install directly from npm.

For an unscoped package, use openclaw plugins install clawhub:episodic-claw@latest. ClawHub pages use the explicit clawhub: source and include @latest on unscoped names to distinguish registry packages from OpenClaw's bundled plugin shortcuts.

Sign in for publishing

Install the ClawHub CLI:

npm i -g clawhub
# or
pnpm add -g clawhub

Sign in with GitHub:

clawhub login
clawhub whoami

Headless environments can use an API token from the ClawHub web UI:

clawhub login --token clh_...

Publish a skill

A skill is a folder with a required SKILL.md file and optional supporting files.

clawhub skill publish ./my-skill \
  --slug my-skill \
  --name "My Skill" \
  --changelog "Initial release"

The command skips unchanged content. New skills start at 1.0.0; later changes automatically publish the next patch version. Use --dry-run to preview or --version to choose an explicit version.

Before publishing, check the metadata in SKILL.md. Declare required environment variables, tools, and permissions so users can understand what the skill needs before they install it. See Skill format.

For repositories containing multiple skills, the reusable GitHub workflow calls skill publish for each immediate skill folder under skills/:

jobs:
  preview:
    uses: openclaw/clawhub/.github/workflows/skill-publish.yml@main
    with:
      dry_run: true

Publish a plugin

Publish a plugin from a local folder, a GitHub repo, a GitHub ref, or an existing archive:

clawhub package publish <source> --family code-plugin --dry-run
clawhub package publish <source> --family code-plugin

Use --dry-run first to preview the resolved package metadata, compatibility fields, source attribution, and upload plan without publishing.

Code plugins must include OpenClaw compatibility metadata in package.json, including openclaw.compat.pluginApi and openclaw.build.openclawVersion.

Inspect before installing

Before installing, use the ClawHub web page or CLI detail commands to inspect metadata, source links, versions, changelogs, and scan status:

clawhub inspect @openclaw/demo
clawhub package inspect <package>

Public listings show the latest scan state. Releases that are held or blocked by moderation may be hidden from search and install surfaces until resolved.