Skip to main content

​
System Requirements

Node.js

Version 18.0.0 or higher required

Operating System

macOS, Linux, or Windows with WSL

​
Installation Methods

pnpm install -g agentuse

# Verify installation
agentuse --version

​
Run Without Installation

Use pnpx or bunx to run AgentUse without installing: 
# Using pnpx
pnpx agentuse@latest run your-agent.agentuse

# Using npx
npx agentuse@latest run your-agent.agentuse

# Using bunx with Bun runtime (faster)
bunx --bun agentuse run your-agent.agentuse

​
Development Setup

Clone and build from source: 
# Clone the repository
git clone https://github.com/agentuse/agentuse.git
cd agentuse

# Enable corepack if pnpm is not available
corepack enable

# Install dependencies with pnpm
pnpm install

# Build the project
pnpm run build

# Link for local development
pnpm link

# Now you can use 'agentuse' command globally
agentuse --version

​
Authentication Setup

AgentUse supports multiple AI providers. Authenticate using the interactive login: 
agentuse auth login

Model Configuration

See the complete authentication guide for OAuth setup, API keys, environment variables, and security best practices.

​
Verify Installation

Check that everything is working:
1

Check Version

agentuse --version
2

Check Authentication

agentuse auth list
# or use the short alias
agentuse auth ls
3

Run Test Agent

echo '---
name: test
model: anthropic:claude-haiku-4-5
---
Say "Installation successful!"' > test.agentuse

agentuse run test.agentuse

​
Docker

AgentUse provides an official Docker image with Node.js, Python, and common utilities pre-installed.

Isolated Environment

Run agents in a sandboxed container using your local credentials and session history.

Self-Hosting

Deploy your own AgentUse server for production workloads and API access.

​
Troubleshooting

If agentuse command is not found after installation:
  1. Check your PATH:
echo $PATH
  1. Find where pnpm installs global packages:
pnpm config get prefix
  1. Add to PATH if needed:
export PATH="$PATH:$(pnpm config get prefix)/bin"
Check your Node.js version:
node --version
If below v18, update Node.js: