Skip to content

Repository files navigation

agents-repo CLI

Official CLI for installing and managing agents-repo packages from the open registry for supported install targets: GitHub Copilot, Cursor, Claude Code, and OpenAI Codex.

Install / run

npx agents-repo@latest --help
npx agents-repo@latest init --targets cursor
npx agents-repo@latest init --targets github-copilot claude-code openai-codex

--target remains an alias for --targets on init. In a fresh project without detectable install markers, pass --targets using a canonical id (for example cursor, github-copilot, claude-code, or openai-codex); otherwise init may exit with code 3.

After install, commit agents-lock.json (and agents.json when it changes) so installs stay reproducible. See docs/commands/init.md and docs/commands/install.md.

Development

npm run build
node dist/bin/agents-repo.js <command>

Commands (init, install, update, remove, search, suggest-agents, list, ci, doctor, and targets) are available today. See docs/commands/init.md, docs/commands/install.md, docs/commands/update.md, docs/commands/remove.md, docs/commands/search.md, docs/commands/suggest-agents.md, docs/commands/list.md, docs/commands/ci.md, docs/commands/doctor.md, and docs/commands/targets.md.

Stack

  • Node.js 24.x (.nvmrc pinned to 24.18.0)
  • npm 12.x (packageManager pinned to npm@12.0.1)
  • TypeScript
  • Vitest for unit tests
  • ESLint, markdownlint, and YAML lint for quality gates

Getting Started

nvm use
corepack enable npm
corepack prepare npm@12.0.1 --activate
npm ci

Common Commands

Command Purpose
npm run env:check Verify Node/npm versions
npm run lint:all Markdown, ESLint, and YAML lint
npm run typecheck TypeScript check
npm run test Sync script tests + Vitest
npm run check:secrets Scan tracked files for secret patterns
npm run build Compile src/bin/agents-repo.ts to dist/
npm run sync:ide-instructions Regenerate IDE instruction mirrors
npm run agents:install Install registry workflow packages from agents.json
npm run agents:update Refresh installed packages within semver ranges

Run the full PR baseline locally:

npm run env:check && npm run lint:all && npm run typecheck && npm test && npm run check:secrets

CLI Commands

Command Documentation
init docs/commands/init.md
install / i docs/commands/install.md
update / up docs/commands/update.md
remove / rm docs/commands/remove.md
search / find docs/commands/search.md
suggest-agents / suggest docs/commands/suggest-agents.md
list / ls docs/commands/list.md
ci docs/commands/ci.md
doctor docs/commands/doctor.md
targets docs/commands/targets.md

IDE Agent Instructions

Tool Path
GitHub Copilot .github/copilot-instructions.md
Cursor .cursor/rules/agents-cli.mdc
Claude Code CLAUDE.md
OpenAI Codex AGENTS.md

Regenerate after editing copilot-instructions.md:

npm run sync:ide-instructions

Do not edit .cursor/rules/agents-cli.mdc, CLAUDE.md, or AGENTS.md directly.

Platform repository dogfooding

Organization platform repositories (registry, webapp, cli, registry-proxy, and .github) commit agents.json, agents-lock.json, and CLI-extracted package paths alongside generated project-guideline mirrors. See organization CONTRIBUTING — Registry workflow packages for the shared install and mirror workflow.

Contributing

See .github/CONTRIBUTING.md, docs/development.md, and docs/npm-publishing.md (npm releases and trusted publishing).

About

The official CLI engine for agents-repo. Initialize, install, and manage AI agent configurations and development workflows directly from your terminal. Compatible with MCP.

Topics

Resources

Code of conduct

Contributing

Security policy

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Used by

Contributors

Languages