Skip to content

Latest commit

 

History

History
124 lines (101 loc) · 3.44 KB

File metadata and controls

124 lines (101 loc) · 3.44 KB
title Quickstart
description Install a zombie and have your agent running with two commands.
```bash npm install -g @usezombie/zombiectl zombiectl --version ``` ```bash zombiectl login ```
Opens your browser for authentication. Your session is stored locally.
```bash zombiectl install lead-collector ```
This creates a `lead-collector/` directory in your current directory containing two files:
`SKILL.md` (agent instructions) and `TRIGGER.md` (deployment config — trigger, skills,
credentials, budget, network allowlist).

Open `TRIGGER.md` to see what's inside:

```markdown TRIGGER.md
---
name: lead-collector
trigger:
  type: webhook
  source: agentmail
  event: message.received
credentials:
  - agentmail_api_key
budget:
  daily_dollars: 5.0
  monthly_dollars: 29.0
network:
  allow:
    - api.agentmail.to
---

This zombie qualifies inbound sales email.
```

The companion `SKILL.md` carries the agent instructions in natural language — who the
agent is, what events it receives, what to do with each.
```bash zombiectl credential add agentmail_api_key --value=$AGENTMAIL_KEY ```
Credentials are stored encrypted in the UseZombie vault — your agent never sees them.
The firewall injects them per-request, outside the sandbox boundary.
```bash zombiectl up ```
This uploads your config, provisions a webhook endpoint, and starts the persistent agent
process in the UseZombie cloud. Within seconds your zombie is live and waiting for events.

You will see output like:

```
✓ zombie created  id=019abc12-8d3a-7f13-8abc-2b3e1e0a6f11
✓ webhook live    POST https://hooks.usezombie.com/v1/webhooks/019abc12-8d3a-7f13-8abc-2b3e1e0a6f11
✓ agent running   status=alive
```
```bash curl -X POST https://hooks.usezombie.com/v1/webhooks/ \ -H "Authorization: Bearer your-webhook-token" \ -H "Content-Type: application/json" \ -d '{"event_id":"test-001","type":"email.received","data":{"from":"alice@example.com","subject":"Demo request"}}' ``` ```bash zombiectl status zombiectl logs --zombie ```
The zombie ID appears in the `zombiectl up` output (`zm_01…`). `zombiectl logs` streams the activity stream — every event received, every action taken, every
credential used — with timestamps and token counts.
```bash zombiectl kill lead-collector ```
The zombie stops immediately. No lingering processes, no billing after the kill.

What's next?

Understand the credential firewall and sandbox model. Zombies, triggers, skills, credentials, and the kill switch. Full command reference for zombiectl.