PARELdocs
ConsoleHome
/

Quickstart

Deploy your first agent from a single spec. It can be a short job or a durable session; you own the model, plugins, and runtime intent declared in agent.yaml.

# 1. Create a workspace

Open Console to sign up or sign in. New users first create or pick a workspace, then enter the console.

# 2. Install the CLI

shell
npm install -g @parel/cli

# 3. Log in

Create a workspace API key in Console → Settings, then run:

shell
parel login
# API key: pk_your_key_here
# Logged in. https://api.parel.sh  pk_your...here

# 4. Configure provider access

The example below uses Anthropic as the model provider and E2B as the sandbox. The Anthropic model can use a workspace BYOK key or platform billing. The E2B key is bound in agent.yaml via the ${E2B_API_KEY} secret reference; just export it before deploying, and parel deploy encrypts and uploads it scoped to the agent.

shell
# Model BYOK; skip this if you use platform-billed Anthropic.
parel provider-keys set anthropic --from-env ANTHROPIC_API_KEY

# Sandbox key: referenced as ${E2B_API_KEY} in agent.yaml below.
export E2B_API_KEY=e2b_...

# 5. Create agent.yaml

This is the only file you have to write. It declares the agent's model, tools, memory, budget, and runtime limits, and it is suitable for code review. Secret values do not go in this file — write only ${NAME} references.

agent.yaml
version: "1"
agent:
  name: my-first-agent
model:
  provider: anthropic
  model: claude-sonnet-5
plugins:
  - system-static:
      prompt: "You are a helpful research assistant."
  - sandbox-e2b:
      apiKey: ${E2B_API_KEY}
  - memory-rolling-summary
  - budget-cap:
      max_usd: 10
runtime:
  maxSteps: 100

# 6. Deploy

shell
parel capabilities doctor agent.yaml
parel deploy agent.yaml
# Secrets
#   ✓ E2B_API_KEY  from local env → agent-level (e2b_***)
# Deployed: my-first-agent  agt_a1B2c3D4e5F6

# 7. Chat

shell
parel chat --agent agt_a1B2c3D4e5F6

  PAREL Chat
  session: ssn_x1Y2z3A4b5C6
  type /quit to exit, /messages for conversation log

$ What's trending on Hacker News?
▸ Let me check...
  [tool] bash({"command": "curl ..."})
  [result] {"output": "..."}
▸ Here's what I found: ...

$ /quit

# 8. Monitor

Open parel.sh/console to view agent sessions, costs, and live traces.

Next: read Concepts to understand how the kernel, plugins, and sessions work together.