Getting Started with AgentPress

Get up and running with AgentPress in under 5 minutes.

Prerequisites

Before you begin, make sure you have:

Node.js >= 20
Bun >= 1.3.0
Docker and Docker Compose
PostgreSQL 16
Turbo CLI
GitHub Personal Access Token (for accessing AgentPress template)

⚠️ Beta Access Required: AgentPress is currently in beta. You’ll need to request a GitHub Personal Access Token from an AgentPress admin to access the template repository.
npm Access Token (with Read permissions)

⚠️ Beta Access Required: The npm Access Token must be generated and issued by the AgentPress team to access private AgentPress packages. Please contact the team to request an npm token.

For Prerequisites installation go to this link

Quick Start

1. Create your project


npx @agentpress/cli@latest create my-agent-press-app

The CLI will prompt you for:

GitHub token (for downloading the template)
npm token (for accessing AgentPress packages)
Whether to run the setup wizard

2. Configure your application

The setup wizard will guide you through:

Database configuration (PostgreSQL)
Admin password setup
AI provider API keys (OpenAI, Anthropic, etc.)

3. Start developing


# 1. Go to the app folder
cd my-ai-app
 
# 2. Install dependencies
bun install
 
# 3. Set up environment variables
# Copy the example file and add your OpenAI API key
cp apps/api/.env.example apps/api/.env
# Edit apps/api/.env and set OPENAI_API_KEY=your_key_here
 
# 4. Start the database (see detailed instructions below)
docker compose -f .dev/docker-compose.yml up -d

Required Configuration:

OPENAI_API_KEY - Add your OpenAI API key to apps/api/.env
DATABASE_URL - Update the port if needed (default is 5432, but README mentions 5555)
All other variables have sensible defaults in .env.example


# 5. Run database migrations
bun run build
cd apps/api
bun db:migrate
cd ../..
 
# 6. Start the development servers
bun dev

Your application is now running:

Console: http://localhost:3000 - Configure agents, tools, and knowledge bases
API: http://localhost:3001 - Backend server

What You Get

A complete, production-ready AI agent platform:

🎨 Next.js Frontend - Modern React with Tailwind CSS
🚀 Node.js Backend - Express API with authentication
🤖 AI Integration - Multi-provider support (OpenAI, Anthropic, Google, xAI)
🗄️ Database - PostgreSQL with Prisma ORM
🔐 Authentication - GitHub OAuth ready
🎤 Voice Support - Optional Ultravox integration
📱 Responsive UI - Mobile-friendly interface

Next Steps

Using the CLI - Learn all CLI commands
Configure GitHub OAuth - Set up user authentication
Customize your agents - Modify AI behavior in apps/api/src/agents/
Add custom tools - Create tools in packages/custom/src/tools/

Need Help?

Run npx @agentpress/cli@latest --help for command reference
Check SETUP.md in your project for detailed instructions