Skip to content

Getting Started

This guide will walk you through setting up Uranus for local development and deploying to Cloudflare.

Prerequisites

  • Node.js 18.x or later
  • npm or pnpm
  • Cloudflare Account with Workers enabled
  • Wrangler CLI (installed as a dev dependency)

Installation

1. Clone the Repository

bash
git clone https://github.com/anthropics/uranus.git
cd uranus/manage

2. Install Dependencies

bash
npm install

3. Configure Cloudflare Resources

Create the required Cloudflare resources:

bash
# Create D1 database
wrangler d1 create agents-dashboard

# Create R2 bucket
wrangler r2 bucket create agents-dashboard-files

# Create Vectorize index
wrangler vectorize create agents-dashboard-embeddings \
  --dimensions=768 \
  --metric=cosine

4. Update wrangler.toml

Update your wrangler.toml with the resource IDs:

toml
[[d1_databases]]
binding = "DB"
database_name = "agents-dashboard"
database_id = "YOUR_DATABASE_ID"

[[r2_buckets]]
binding = "BUCKET"
bucket_name = "agents-dashboard-files"

[[vectorize]]
binding = "VECTORIZE"
index_name = "agents-dashboard-embeddings"

5. Run Database Migrations

bash
# Apply the main schema
wrangler d1 execute agents-dashboard --file=./schema.sql

# Apply migrations
wrangler d1 execute agents-dashboard --file=./migrations/002_multi_agent.sql
wrangler d1 execute agents-dashboard --file=./migrations/003_agent_auth.sql
wrangler d1 execute agents-dashboard --file=./migrations/004_workflow_executions.sql
wrangler d1 execute agents-dashboard --file=./migrations/005_cloudflare_settings.sql
wrangler d1 execute agents-dashboard --file=./migrations/006_browser_actions_types.sql
wrangler d1 execute agents-dashboard --file=./migrations/007_puppeteer_action_types.sql

Development

Start the Development Server

Run both the frontend and backend development servers:

bash
# Terminal 1: Wrangler dev server (port 8787)
npm run dev

# Terminal 2: Vite dev server (port 5173) - optional for HMR
npm run dev:frontend

Access the dashboard at http://localhost:8787

Project Scripts

CommandDescription
npm run devStart Wrangler development server
npm run dev:frontendStart Vite dev server with HMR
npm run buildBuild frontend for production
npm run previewBuild and preview with Wrangler
npm run deployDeploy to Cloudflare
npm run cf-typegenGenerate Cloudflare types

First Steps

1. Create Your First Agent

Navigate to the dashboard and create a new agent:

  1. Open http://localhost:8787
  2. Click "Create Agent"
  3. Enter a name and description
  4. Configure the LLM settings

2. Set Up a Simple Workflow

  1. Go to Workflows in the sidebar
  2. Click "New Workflow"
  3. Drag nodes from the palette
  4. Connect nodes to create a flow
  5. Save and test your workflow

3. Try the Chat Interface

  1. Navigate to Chat
  2. Send a message to your agent
  3. Observe the AI response and any tool calls

4. Schedule a Task

  1. Go to Schedules
  2. Create a new schedule with a cron expression
  3. Link it to a workflow
  4. Watch it execute on schedule

Configuration

Environment Variables

Configure in wrangler.toml or via Cloudflare dashboard:

toml
[vars]
ENVIRONMENT = "development"

# Optional: Browserbase for browser automation
BROWSERBASE_PROJECT_ID = "your_project_id"
BROWSERBASE_API_KEY = "your_api_key"

# Optional: Cloudflare Access
CF_ACCESS_AUD = "your_access_audience"

Agent Settings

Each agent can be configured with:

  • LLM Provider - Workers AI, OpenAI, or Anthropic
  • Model - Specific model to use
  • Temperature - Response creativity (0-1)
  • System Prompt - Agent behavior instructions
  • Calendar - Timezone and working hours
  • Browser - Viewport, headless mode, user agent

Next Steps

Released under the MIT License.