Skip to content
OpenAgentsbeta

Getting Started

Install your first OpenAgents package and understand how the pieces fit together.

Getting Started

OpenAgents is an open-source marketplace for agentic workflows, harnesses, rules, and skills — packaged agent behaviors you install into your own agent runtime (Claude Code, Cursor, Codex CLI, OpenAI Agents SDK, LangGraph, or a generic layout), the way you'd install a package from npm or a model from Hugging Face.

Install a package

The fastest way to try OpenAgents is the CLI, run without installing anything — once openagents is published to npm (it ships from cli/ as its own package, released by the cli-v* tag workflow; until a release has shipped, npx openagents and npx github:WolfeIntelligence/openagents won't resolve, since npm git specifiers run whatever bin the repository root's package.json declares, and that's the site, not the CLI). Until then, clone the repo and run the CLI directly from source:

bash
git clone https://github.com/WolfeIntelligence/openagents.git
cd openagents/cli && npm install
node bin/openagents.js add openagents/pr-reviewer

Once a release is out, the one-liner will be:

bash
npx openagents-cli add openagents/pr-reviewer

This does three things:

  1. Fetches the package manifest from the registry (https://openagents-nu.vercel.app by default).
  2. Downloads the package's files as a tarball.
  3. Extracts them into the right directory for your project's runtime — auto-detected from marker directories (.claude/, .cursor/, .codex/, etc.), or set explicitly:
bash
npx openagents-cli add openagents/pr-reviewer --runtime claude-code

See CLI Reference for every command, and Runtimes for the full install-directory table and how each runtime picks the files up.

Browse without installing

  • Web: /explore — filter by kind, runtime, price, and search text.
  • API: GET /api/v1/search?q=code+review — see API Reference.
  • CLI: npx openagents-cli search "code review".
  • Collections: /collections — curated, ordered lists of packages someone put together around a theme ("everything for PR review"), each with a one-paste "copy install-all" command; see Publishing.
  • Organizations: /org/{handle} — a shared publisher identity's packages, bio, and website, the same shape as a creator's own profile; see Publishing.
  • Changelog: /changelog (add ?owner= to scope it to one creator) lists every version published across the catalog, newest first; a given package's own version history and diffs live on its compare page below. /changelog.xml is the same feed as RSS/Atom.
  • RSS: /feed.xml for newly published/updated packages, if you'd rather watch the catalog from a feed reader than check back on /explore.
  • Keyboard shortcuts: / focuses search from anywhere; g e goes to Explore, g h home, g t Tags, g c Collections; ? shows the full shortcut list.
  • Recently viewed: the landing page keeps a "recently viewed" rail of packages you've opened, stored locally in your browser (not synced to your account or visible to anyone else).

Each package's detail page (/p/<owner>/<name>) shows its README, full manifest, file tree, and version history before you install anything. A creator can also embed status badges (version, downloads, stars, rating) from GET /api/v1/packages/{owner}/{name}/badge in their own README or site — see API Reference.

Understand what you're installing

Every package is a directory with an openagent.yaml manifest plus a README.md and its actual files (an instruction file, templates, scripts, schemas — whatever the package needs). There are four kindsworkflow, harness, rules, skill — each meant to be loaded into your agent's context differently. Read Package Format for the full manifest reference and Kinds for what distinguishes each one.

Try the free catalog

28 packages ship free and bundled with the project under catalog/openagents/ — no sign-in, no payment, always available even with zero environment variables configured server-side. A good first one to try:

bash
npx openagents-cli info openagents/pr-reviewer
npx openagents-cli add openagents/pr-reviewer

Comparing versions

Every package's detail page links to a compare view — /p/{owner}/{name}/compare?from=&to=&view=split|unified — showing a file-by-file diff between any two published versions, side-by-side or unified. Useful for deciding whether to update, or for a reviewer checking exactly what changed before approving a flagged version. See API Reference for the underlying diff endpoint.

Publish your own

Free packages are contributed via pull request to the catalog/ directory; packages with a price go through the hosted publish flow (or openagents publish from the CLI, once you've openagents login'd — see CLI Reference) and go live immediately once validation passes, unless the deployment requires review first (or the automated content scan flags it — see Publishing). A package can be owned by you personally or by an organization you're a member of — see Publishing. See Publishing for both paths, review mode, and the content policy.

Run OpenAgents yourself

The whole app builds and runs with zero environment variables set — it falls back to the bundled seed catalog with auth and payments disabled. See Self-Hosting to deploy your own instance, optionally with a database, GitHub/Google auth, and Stripe Connect payments enabled.

Keyboard shortcuts

Focus search
/
Go to Explore
ge
Go to Home
gh
Go to Tags
gt
Go to Collections
gc
Show this help
?
Close suggestions or this dialog
Esc