Installation

Install agentrc CLI and configure your development environment.

System Requirements

  • Node.js 18.0 or higher
  • npm 9.0 or higher (or pnpm/yarn)
  • Git 2.0 or higher

Quick Install

Install globally via npm:

npm install -g @agentrc/cli

Or use your preferred package manager:

# pnpm
pnpm add -g @agentrc/cli

# yarn
yarn global add @agentrc/cli

# bun
bun add -g @agentrc/cli

Verify installation:

agentrc --version
You should see the version number printed. If you get a "command not found" error, make sure your global npm bin directory is in your PATH.

Using npx (No Installation)

Run agentrc without installing:

npx @agentrc/cli init
npx @agentrc/cli sync
npx @agentrc/cli classify "git checkout main"

This is useful for:

  • Trying agentrc before committing to installation
  • CI/CD environments
  • One-off commands
npx downloads and caches the package, so subsequent runs are fast.

Configuration

After installation, initialize agentrc in your project:

cd your-project
agentrc init

This creates:

your-project/
├── .agentrc/
│   ├── config.yml          # Main configuration
│   ├── rules/              # Coding standards
│   ├── commands/           # Custom commands
│   └── policies/           # Security policies
└── .gitignore              # Updated to include .agentrc/cache
The .agentrc/ directory should be committed to version control. The cache directory is automatically added to .gitignore.

Next Steps