Resource kinds
Generated from the code by
apps/docs/scripts/reference.mjs: edit the source, not this page.
Everything a formula (.wisp/*.wisp.yml, or wisp apply -f file) can declare, one section per top-level key. Each key takes a list of named items (- name: reviewer). wisp schema prints the same as JSON Schema, for your editor.
The formula
| Field (? optional) | Type | What it is |
|---|---|---|
accounts? |
[account] | map of account | A harness account (its sign-in stays in the harness’s own folder). |
agents? |
[agent] | map of agent | A named, reusable agent: which harness and how it runs (“reviewer = codex, high effort, plan mode, the linear connector”). A task, a crew member, a team slot or a judge names one, or gives one inline. |
apps? |
[app] | map of app | An app or a pane: where its code comes from and what it may do. |
budget? |
[budget] | map of budget | Where unattended work stops on a usage window, and what a task or workflow may spend. |
capabilities? |
[capability] | map of capability | A capability set: what its holder may do. |
channels? |
[channel] | map of channel | A channel: where people talk to wisp and hear back from it. |
connectors? |
[connector] | map of connector | An MCP server: a command wisp starts, or a URL it reaches. |
crew? |
[crew] | map of crew | A crew member: who they are, what runs their jobs, when they check in. |
factories? |
[factory] | map of factory | A software factory (factories: in a formula). |
goals? |
[goal] | map of goal | A goal: what done means and how it’s judged after each turn. goals.default has no text: it’s every goal’s judges, vote, round limit and sandbox. |
harnesses? |
[harness] | map of harness | A harness CLI: where it comes from, which version is trusted, its own defaults. |
include? |
string | [string] | other formulas read first (paths, URLs) |
machines? |
[machine] | map of machine | A computer: this one (this) or a peer wisp reaches. |
notifications? |
[notification] | map of notification | What notifies where: events to a channel or a webhook. |
panes? |
[pane] | map of pane | An app or a pane: where its code comes from and what it may do. |
pipelines? |
[pipeline] | map of pipeline | The steps after a run, by name (a task or a workflow step names one: pipeline: careful). |
plugins? |
[plugin] | map of plugin | A plugin by its id (wisp.telegram, user.mine). |
profiles? |
map of object | parts picked with –profile NAME |
projects? |
[project] | map of project | A project: a folder wisp works in, and how. |
settings? |
map of setting | Settings by key (wisp settings list) |
skills? |
[skill] | map of skill | A skill given to agents: a folder or file, or the text inline. |
tasks? |
[task] | map of task | A task you can run by name, by schedule or from a trigger. |
teams? |
[team] | map of team | A lead and the subagents it may hand work to. |
tools? |
[tools] | map of tools | wisp’s tools for one agent profile or mode (its name): what it gets and what it doesn’t. |
triggers? |
[trigger] | map of trigger | A trigger. |
ui? |
[ui] | map of ui | How wisp looks on this device. |
wisp |
1 |
the formula format |
workflows? |
[workflow] | map of workflow | A workflow: its steps by name, and what bounds a run. |
accounts: (account)
A harness account (its sign-in stays in the harness’s own folder).
| Field (? optional) | Type | What it is |
|---|---|---|
kind? |
string | personal | work |
label? |
string | what it shows as |
agents: (agent)
A named, reusable agent: which harness and how it runs (“reviewer = codex, high effort, plan mode, the linear connector”). A task, a crew member, a team slot or a judge names one, or gives one inline.
| Field (? optional) | Type | What it is |
|---|---|---|
account? |
string | a harness account by name (accounts are personal: never exported unless asked) |
connectors? |
[string] | connectors (MCP servers) it gets, by name |
effort? |
string | low | medium | high | the harness’s own levels |
harness? |
string | the harness that runs it (claude, codex, cursor, opencode, …; auto lets the router pick) |
instructions? |
string | standing instructions every task it runs starts with |
mode? |
string | plan | edits | auto |
model? |
string | the harness’s model id (‘’ = the harness’s own default) |
skills? |
[string] | skills it gets, by name |
subagentModel? |
string | the model its subagents use |
apps: (app)
An app or a pane: where its code comes from and what it may do.
| Field (? optional) | Type | What it is |
|---|---|---|
enabled? |
boolean | off: kept but not shown |
grants? |
[string] | what it may call (commands, topics) |
inline? |
string | its code inline (a single-file app) |
schema? |
its data’s shape (JSON Schema) | |
source? |
string | a folder, or starter:<name> for one wisp ships |
budget: (budget)
Where unattended work stops on a usage window, and what a task or workflow may spend.
| Field (? optional) | Type | What it is |
|---|---|---|
claude? |
string | Claude Code’s own line (same | off | 50 | 75 | 90) |
codex? |
string | Codex’s own line (same | off | 50 | 75 | 90) |
drainWatch? |
boolean | warn when a window is about to drain |
stopAt? |
string | off | 50 | 75 | 90: percent of a window where automations stop |
taskUsd? |
number | at most this many dollars per task |
capabilities: (capability)
A capability set: what its holder may do.
| Field (? optional) | Type | What it is |
|---|---|---|
allow? |
[string] | permissions it grants (runtime:create, crew:*) |
channels? |
[string] | the channels whose messages act with it |
deny? |
[string] | permissions it never grants, over allow |
key? |
string | an API key that holds it, as ${secret:NAME} |
channels: (channel)
A channel: where people talk to wisp and hear back from it.
| Field (? optional) | Type | What it is |
|---|---|---|
allow? |
[string] | who may speak to it (chat ids, user names, addresses) |
cap? |
string | the most a message may start: plan | edits (never auto) |
enabled? |
boolean | off by default: nothing is received or sent until it’s on |
routing? |
the transport’s own settings (ntfy: server, topic; Slack: appToken…), merged into its config; where its tasks run (a project or machine), and thread rules |
|
token? |
string | its bot token or key, as ${secret:NAME} |
transport |
string | telegram | slack | discord | github | email | ntfy |
connectors: (connector)
An MCP server: a command wisp starts, or a URL it reaches.
| Field (? optional) | Type | What it is |
|---|---|---|
agents? |
[string] | the agent profiles that get it (empty: every one) |
args? |
[string] | |
command? |
string | the program (stdio servers) |
enabled? |
boolean | off: declared but no agent gets it |
env? |
map of string | its environment; secrets as ${secret:NAME} |
headers? |
map of string | HTTP headers; secrets as ${secret:NAME} |
modes? |
[string] | the modes that get it (plan, edits, auto; empty: all) |
oauth? |
boolean | it signs in with OAuth (the token stays in secrets) |
url? |
string | the server’s URL (HTTP servers) |
crew: (crew)
A crew member: who they are, what runs their jobs, when they check in.
| Field (? optional) | Type | What it is |
|---|---|---|
agent? |
string | an agent profile’s name or a harness (reviewer, codex) |
avatar? |
string | a spirit code or an emoji (‘’ rolls one from the name) |
brief? |
string | the standing instructions every job of theirs starts with |
color? |
string | |
cron? |
string | when they check in: a cron, or words (“every weekday at 9”) |
cwd? |
string | the folder they work in |
effort? |
string | |
kit? |
[any] | their kit: [{ name, description?, body }] skills and notes |
machine? |
string | the computer their jobs run on (‘’ = this one) |
mode? |
string | plan | edits | auto |
model? |
string | |
notebook? |
string | their notebook (a file: it stays a file) |
on? |
[string] | The “also starts when” (ci, done, finished): read as wakes on import |
parallel? |
integer | how many of their jobs may run at once |
paused? |
boolean | no check-ins or jobs until resumed |
role? |
string | what they do (“reviewer”, “release manager”) |
sandbox? |
string | ‘’ | job | own: a worktree per job, or one of their own |
team? |
[any] | who they delegate to: [{ crew, why? }] |
wakes? |
[crew.TriggerSpec] | what else wakes them (ADR-0043): triggers whose target is this member (on: crew.reported, on: pr.review_requested, on: schedule …); cron stays the shorthand for one schedule |
crew.Budget
What a trigger may spend.
| Field (? optional) | Type | What it is |
|---|---|---|
perDay? |
number | USD a day, across its runs |
perRun? |
number | USD a run (the run is stopped past it, by wisp.budget’s guard) |
crew.TriggerSpec
A trigger.
| Field (? optional) | Type | What it is |
|---|---|---|
agent? |
string | |
approval? |
boolean | the job waits for a yes before it starts (never in Full auto) |
at? |
integer | once: when (ms since the epoch) |
branch? |
string | |
budget? |
crew.Budget | |
concurrency? |
string | skip | queue | replace | parallel: |
cooldown? |
string | after a failed run, wait this long before the next (“30m”) |
crew? |
string | a crew member gets the work instead (a wake) |
cron? |
string | schedule: a cron or words (“every weekday at 9”) |
debounce? |
string | events within this window become one job listing them all (“10m”, “30s”) |
enabled? |
boolean | |
every? |
integer | minutes between polls (a polled source) |
factory? |
string | the software factory its own prompt runs through (ADR-0114; a declared task: says its own) |
followUp? |
boolean | or a follow-up to the task the event came from |
header? |
string | webhook: the header that signs each call (X-Hub-Signature-256, Sentry-Hook-Signature, Linear-Signature, X-PagerDuty-Signature): an HMAC-SHA256 of the body under the secret, hex, with or without sha256=/v1=. With it the secret is never sent, only checked. |
if? |
string | an expression over event (event.payload.branch == 'main'), as workflows’ if |
label? |
string | an issue’s or PR’s label |
match? |
object | any other field of the source, matched against the event’s payload (a string, a glob, or a list) |
mode? |
string | plan | edits | auto |
model? |
string | |
on |
string | the source: schedule, once, webhook, manual, or an event type (task.finished, pr.opened, chat.message, …) |
project? |
string | the project it watches, and the folder its task runs in |
prompt? |
string | or a prompt of its own: {event.summary}, {event.payload.x} are filled in |
rate? |
string | at most this many runs: “5/h”, “20/d” |
secret? |
string | webhook: its secret, as ${secret:NAME} |
task? |
string | the declared task it starts (its {params} from the event) |
tz? |
string | schedule and when: an IANA zone (“Europe/Zurich”); this computer’s by default |
users? |
[string] | chat.message: who may (names or ids; anyone for an open channel) |
when? |
crew.When | |
workflow? |
string | or a workflow runs, with the event as its input |
crew.When
When a trigger may run: outside these, an event is skipped or queued until the window opens.
| Field (? optional) | Type | What it is |
|---|---|---|
days? |
[string] | mon tue wed thu fri sat sun (every day when empty) |
hours? |
string | “9-17” (local hours, start inclusive, end exclusive) |
outside? |
string | skip (default) | queue |
tz? |
string |
factories: (factory)
A software factory (factories: in a formula).
| Field (? optional) | Type | What it is |
|---|---|---|
budget? |
{ usd: 20 }: no new station starts once the run’s stations have cost this much |
|
description? |
string | |
loop? |
factory.Loop | |
stations |
factory.Stations |
factory.BuildStation
Builds it, in a worktree of its own.
| Field (? optional) | Type | What it is |
|---|---|---|
agent? |
string | |
agents? |
[string] | two or more build it side by side, each in its own worktree; the first whose checks pass goes on |
mode? |
string | plan | edits | auto (default: the run’s) |
prompt? |
string | |
worktree? |
boolean | a worktree of its own (default: yes, in a project) |
factory.ChecksStation
The gate that is code: commands run in the build’s folder, in order; one that exits non-zero fails it.
| Field (? optional) | Type | What it is |
|---|---|---|
run? |
[string] | each sh -c in the build’s folder (none: the project’s own test command) |
timeout? |
integer | minutes each may run (default 10) |
factory.Loop
Where a failed check or review goes, how many rounds it may take, and what happens past them.
| Field (? optional) | Type | What it is |
|---|---|---|
back_to? |
string | build (the default) | spec |
max? |
integer | rounds in all (default 3; 0: a failure goes straight to then) |
then? |
string | ask (the default): it asks you whether to keep going | stop: the run ends failed |
factory.ReviewStation
Reviewers read the build’s folder and each says APPROVE or CHANGES: what to fix.
| Field (? optional) | Type | What it is |
|---|---|---|
agent? |
string | |
agents? |
[string] | |
prompt? |
string | |
vote? |
string | majority (the default) | all | any |
factory.ShipStation
Opens the PR from the build’s worktree, and merges it.
| Field (? optional) | Type | What it is |
|---|---|---|
draft? |
boolean | |
merge? |
string | human (the default): it asks before merging | auto: merges once it’s open | none: leaves it open |
pr? |
boolean | open a PR (default: yes) |
factory.SpecStation
Writes the spec: its answer is what every later station is given. Read-only (Plan mode).
| Field (? optional) | Type | What it is |
|---|---|---|
agent? |
string | an agent profile’s name or a harness (‘’ : the task’s, else your default) |
approve? |
string | human (the default): the run waits for your yes on the spec; none: it goes on by itself |
prompt? |
string | more instructions for it |
factory.Stations
A factory’s stations: the ones it has, always run in this order.
| Field (? optional) | Type | What it is |
|---|---|---|
build? |
factory.BuildStation | |
checks? |
factory.ChecksStation | |
review? |
factory.ReviewStation | |
ship? |
factory.ShipStation | |
spec? |
factory.SpecStation |
goals: (goal)
A goal: what done means and how it’s judged after each turn. goals.default has no text: it’s every goal’s judges, vote, round limit and sandbox.
| Field (? optional) | Type | What it is |
|---|---|---|
judges? |
array | the agent profiles that judge; [] on purpose: no judges, the task’s own quick check |
maxRounds? |
integer | turns a goal may take before it stops and asks |
sandbox? |
boolean | its judges run in a sandbox of their own, seeded with the task’s folder (ADR-0047) |
text? |
string | what has to be true for it to be met (“npm test passes and the build is green”) |
vote? |
string | majority | all | any |
harnesses: (harness)
A harness CLI: where it comes from, which version is trusted, its own defaults.
| Field (? optional) | Type | What it is |
|---|---|---|
effort? |
string | |
enabled? |
boolean | installed or not (false: wisp never offers it) |
from? |
string | npm | brew | path |
lean? |
boolean | lean runs: wisp’s short base prompt instead of the harness’s own |
liveLimits? |
boolean | read its usage limits while it runs |
model? |
string | |
package? |
string | what from installs: the npm package (default: the harness’s own) or the brew formula |
path? |
string | its program when from: path |
pin? |
string | the version wisp trusts (a newer one asks first); from: npm installs this one |
machines: (machine)
A computer: this one (this) or a peer wisp reaches.
| Field (? optional) | Type | What it is |
|---|---|---|
address? |
string | its address (host, ssh target or grid name) |
limits? |
machine.MachineLimits | |
onGrid? |
boolean | this computer is on the grid, so other computers reach it |
port? |
integer | its wisp’s port (ssh, loopback), when it isn’t the default |
transport? |
string | local | ssh | grid | grid-tunnel |
machine.MachineLimits
What a computer may take on before automations wait.
| Field (? optional) | Type | What it is |
|---|---|---|
batteryHold? |
integer | on battery under this percent, check-ins and the crew queue wait (off, 20 or 40) |
cpuCeiling? |
integer | automations wait while the CPU stays over this percent of its cores |
heavyLock? |
boolean | one heavy step (a build, the tests) at a time |
maxRuns? |
integer | runs at once (default: one per 3 GB of memory) |
memoryFloor? |
integer | automations wait while free memory is under this percent |
notifications: (notification)
What notifies where: events to a channel or a webhook.
| Field (? optional) | Type | What it is |
|---|---|---|
on |
[string] | events: finished, asks, failed, limit, drain, a trigger’s name |
projects? |
[string] | only for these projects (empty: every one) |
to |
string | a channel’s name, or a webhook URL |
panes: (pane)
An app or a pane: where its code comes from and what it may do.
| Field (? optional) | Type | What it is |
|---|---|---|
enabled? |
boolean | off: kept but not shown |
grants? |
[string] | what it may call (commands, topics) |
inline? |
string | its code inline (a single-file app) |
schema? |
its data’s shape (JSON Schema) | |
source? |
string | a folder, or starter:<name> for one wisp ships |
pipelines: (pipeline)
The steps after a run, by name (a task or a workflow step names one: pipeline: careful).
| Field (? optional) | Type | What it is |
|---|---|---|
atLimit? |
string | at a usage limit: next (another account or harness) | wait |
bestOf? |
integer | run it this many times and keep the best |
judge? |
string | the agent profile that picks the best, or reviews |
onError? |
string | on an error: escalate (a stronger model) | retry | stop |
review? |
string | a review by this agent profile after each run |
plugins: (plugin)
A plugin by its id (wisp.telegram, user.mine).
| Field (? optional) | Type | What it is |
|---|---|---|
config? |
its own configuration | |
enabled? |
boolean | on or off |
source? |
string | where a user’s plugin comes from: a path, gist:<id> or a URL |
version? |
string | the version it stays on |
profiles: (account)
A harness account (its sign-in stays in the harness’s own folder).
| Field (? optional) | Type | What it is |
|---|---|---|
kind? |
string | personal | work |
label? |
string | what it shows as |
projects: (project)
A project: a folder wisp works in, and how.
| Field (? optional) | Type | What it is |
|---|---|---|
agent? |
string | the agent profile or harness its tasks use unless they say |
color? |
string | |
instructions? |
string | notes every task in it starts with (learned preferences, per-project rules) |
path |
string | the folder (absolute), or a repo URL cloned into the worktree dir |
run? |
[string] | commands that start the project (a dev server), for Run |
setup? |
[string] | commands run in a new worktree before the first turn |
test? |
string | the command that runs its tests (Auto learns from whether a task’s tests pass) |
trust? |
project.ProjectTrust | |
worktree? |
project.WorktreePolicy |
project.ProjectTrust
What a project trusts without asking: its hooks, MCP servers and setup script.
| Field (? optional) | Type | What it is |
|---|---|---|
hooks? |
boolean | |
mcp? |
[string] | the project’s own MCP servers, by name |
setup? |
boolean |
project.WorktreePolicy
How a project uses worktrees.
| Field (? optional) | Type | What it is |
|---|---|---|
cleanupDays? |
integer | days a finished task’s worktree stays before cleanup |
dir? |
string | where clones and worktrees go |
enabled? |
boolean | each task in a worktree of its own |
fixConflicts? |
boolean | resolve merge conflicts with an agent |
include? |
[string] | untracked files copied into each worktree (.env, node_modules) |
max? |
integer | at most this many worktrees at once |
onDone? |
string | when a task is done: ask | remove-clean | keep |
settings: (setting)
Settings by key (wisp settings list)
| Field (? optional) | Type | What it is |
|---|---|---|
accounts.updateCheck? |
boolean | Check for newer harness versions: once a day, wisp asks npm for the latest Claude Code, Codex and opencode (npm then knows which of them you have) |
automations.webhookTriggers? |
boolean | Webhook triggers: other services may start this computer’s webhook triggers (POST /api/triggers/ |
budget.drainWatch? |
boolean | Drain watch: tell the phone when a plan moves much faster than usual for the same work |
budget.limitHold? |
off · 80 · 90 · 95 |
Ask near the limit: before a task would take a usage window past this percent, ask first (automations wait for the reset) |
budget.liveLimits? |
boolean | Check Codex while work waits: read its usage every 10 minutes while work waits for its plan (spends nothing) |
budget.silentStop? |
off · 1 · 2 · 4 · 8 |
Stop a run silent for: stop a run with no output for this many hours (a run silent 30 minutes while its plan moves is always told to your phone) |
budget.spareCard? |
boolean | Spare allowance: say on home when a weekly window resets within a day with a fifth or more left |
budget.windowNotice? |
boolean | Window notices: say when a usage window changed length or resets early |
channels.acceptChannels? |
boolean | Accept tasks from channels: messages routed here through wisp Cloud (“on this computer …”) may start tasks. Switch it on at this computer. |
channels.project? |
string | Default project: where a task from a channel (Slack, Discord, Telegram, email) runs when its message names none (‘’: the last used) |
crew.tint? |
boolean | Crew tint: with the crew rail, the task list takes a very light tint of the colour of the member you pick. |
events.sinks? |
Event sinks | |
git.cloneDir? |
string | Where a pasted repo URL is cloned (‘’: the first of ~/code, ~/dev, ~/Developer, ~/projects… that exists, else ~/code) |
git.maskEnvFiles? |
boolean | Hide .env values: what a task shows of a .env file (its output, edits, blocks, Changes) leaves wisp as dots until you reveal one |
grid-client.previews? |
boolean | Show local pages in previews |
learn.enabled? |
boolean | Learn from your tasks: a short retro after each quiet task, kept as preferences and lessons later tasks follow |
machine.batteryHold? |
off · 20 · 40 |
On battery under this percent, check-ins and the crew queue wait |
machine.cpuCeiling? |
off · 100 · 150 · 200 |
Automations wait while the CPU stays over this percent of a core per core |
machine.maxRuns? |
off · 4 · 6 · 8 · 12 · 16 · auto |
Runs at once before automations wait |
machine.memoryFloor? |
off · 10 · 15 · 20 · 25 |
Automations wait while free memory is under this percent |
review.harness? |
off · other · claude · codex · antigravity · copilot · opencode · cursor · grok |
Review by another harness |
runtime.apps? |
boolean | Interactive answers: agents may answer with a small app |
runtime.auto? |
boolean | Auto: wisp picks the harness, model and thinking level for each task. Off until it’s reworked (the owner, 2026-11-17): the one switch; the app hides Auto while it’s off |
runtime.blocks? |
boolean | wisp blocks: answers come as cards (off: plain markdown) |
runtime.followUp? |
interrupt · queue |
A follow-up while a task works: interrupt it, or queue after it |
runtime.launch? |
New task’s last pick: { agent, models: { |
|
runtime.leanRuns? |
off · on · all |
Lean Claude Code runs (no telemetry or update checks, and no claude.ai connectors): on, only wisp’s own side runs; all, every run; off, none |
runtime.limitWait? |
boolean | Wait for the reset: a task at its usage limit carries on by itself after the reset, in the same conversation |
runtime.projectOrder? |
Your project order (names): the chips, New task’s row and the Projects list show them so; drag to change it | |
runtime.retentionDays? |
integer | Days a finished task stays in the list before it’s archived (0: always) |
runtime.setupAnswerSets? |
The API keys’ capability sets (custom: |
|
runtime.subagentModel? |
task · haiku · sonnet |
The model Claude Code’s subagents run on (task: the task’s own) |
runtime.subagents? |
The team new tasks start with: [{ name, agent, model?, effort?, use? }] (New task pre-fills it; a task’s own team wins) | |
runtime.teams? |
Delegate’s saved teams (presets): [{ id, name, members: [{ name, agent, model?, effort?, use?, count?, machine? }] }]; Presets picks one, Save as preset keeps one | |
runtime.watch? |
boolean | Watch agents work: agents may open what they built in wisp’s browser to check it |
settings.editor? |
string | The editor files open in (vscode, cursor, windsurf, zed, idea, none) |
settings.notify? |
on · off |
Desktop notifications when a task needs you or finishes |
settings.readTimes? |
on · off |
Read times in prompts: a prompt that starts with a time (“in 5 min …”, “tomorrow at 9 …”) is scheduled for then |
settings.timeZone? |
string | Time zone: the one scheduled times are read in, an IANA name like Europe/Zurich (the app sets it from your device) |
settings.transcript? |
on · off |
Open tasks on their transcript instead of the answer |
ship.fixConflicts? |
boolean | Fix merge conflicts by itself: when a task’s PR has conflicts, its agent is asked to fix them without waiting for you |
stuff.panes? |
string | Panes: |
termctx.enabled? |
boolean | Terminal context: wisp in a terminal may attach what just happened there |
terminal.command? |
string | Take over with a custom command ({cmd} is the agent’s resume command) |
terminal.terminal? |
string | Open tasks in: wisp, one of this computer’s terminal apps (its id) or custom |
terminal.terminalSessions? |
on · off |
Babysitting mode: each task opens straight in the agent’s own terminal |
threads.compactAudit? |
boolean | Check compactions: after a compaction, wisp asks a copy of the conversation what it still remembers of the task’s Notes and reminds the agent of what it lost (one short extra run each) |
update.updateChannel? |
stable · beta · nightly |
Update channel |
worktrees.cleanup? |
off · 3 · 7 · 14 · 30 |
Idle worktrees go after this many days (unset: 7, counted from when wisp got it) |
worktrees.max? |
off · 20 · 40 · 80 |
Worktree folders kept before the oldest idle ones go |
worktrees.onDone? |
ask · remove · keep |
When a task is done, its worktree folders |
worktrees.projectAsk? |
on · off |
Ask before trusting a new project’s setup scripts |
worktrees.worktree? |
on · off |
New tasks run in their own worktree by default |
skills: (skill)
A skill given to agents: a folder or file, or the text inline.
| Field (? optional) | Type | What it is |
|---|---|---|
body? |
string | the skill’s text, when it isn’t a file |
description? |
string | what it is for (agents read it to pick it) |
extra? |
extra fields a harness’s skill format has | |
path? |
string | a SKILL.md or its folder |
tasks: (task)
A task you can run by name, by schedule or from a trigger.
| Field (? optional) | Type | What it is |
|---|---|---|
agent? |
string | an agent profile’s name or a harness |
connectors? |
[string] | |
crew? |
string | the crew member it runs for |
effort? |
string | |
factory? |
string | the software factory it runs through (ADR-0114): a factory’s name (default is always there); its stations run it instead of one agent |
goal? |
the goal judged after each turn: a declared goal’s name (green-build, from goals:), or inline ({ text: tests pass, judges: [reviewer] }); { name: green-build, maxRounds: 3 } is the declared one with its own limit |
|
mode? |
string | plan | edits | auto |
model? |
string | |
notes? |
task.SeedNotes | the Notes it starts with (ADR-0097): { goal: …, constraints: [...] }, kept by wisp.threads |
paused? |
boolean | paused: its schedule doesn’t fire (it still runs by hand) |
project? |
string | the folder it runs in |
prompt? |
string | what to do; {param} is filled from the run’s values (every task but tasks.default has one) |
schedule? |
string | when it runs by itself: a cron or words (“every day at 2”), in UTC |
steps? |
[string] | prompts sent after the first, each when the turn before ends |
title? |
string | its name as you wrote it (“Run tests”), shown on its chip, when the name (a key: wisp recipes run run-tests) can’t hold it. |
worktree? |
boolean | run in a worktree of its own |
task.SeedNotes
The Notes a formula’s task starts with (ADR-0097, notes: on a task, ADR-0026/0027): a section’s text, a list section’s items. Unknown sections are refused when the formula is checked.
| Field (? optional) | Type | What it is |
|---|---|---|
constraints? |
[string] | must and must-not, one each |
decisions? |
[string] | what was chosen, and why |
failed? |
[string] | what didn’t work, and why |
files? |
[string] | key files |
goal? |
string | what done looks like |
open? |
[string] | open questions |
state? |
string | where it stands |
teams: (team)
A lead and the subagents it may hand work to.
| Field (? optional) | Type | What it is |
|---|---|---|
lead? |
string | the lead’s agent profile |
members? |
map of team.TeamSlot | its subagents, by name |
team.TeamSlot
One seat on a team.
| Field (? optional) | Type | What it is |
|---|---|---|
agent |
string | an agent profile’s name or a harness |
count? |
integer | copies of it the lead may run at once |
why? |
string | what the lead gives it |
tools: (tools)
wisp’s tools for one agent profile or mode (its name): what it gets and what it doesn’t.
| Field (? optional) | Type | What it is |
|---|---|---|
allow? |
[string] | tool names (wisp_ask, wisp_delegate, wisp_*); empty: every one |
deny? |
[string] | tool names it never gets |
triggers: (trigger)
A trigger.
| Field (? optional) | Type | What it is |
|---|---|---|
agent? |
string | |
approval? |
boolean | the job waits for a yes before it starts (never in Full auto) |
at? |
integer | once: when (ms since the epoch) |
branch? |
string | |
budget? |
trigger.Budget | |
concurrency? |
string | skip | queue | replace | parallel: |
cooldown? |
string | after a failed run, wait this long before the next (“30m”) |
crew? |
string | a crew member gets the work instead (a wake) |
cron? |
string | schedule: a cron or words (“every weekday at 9”) |
debounce? |
string | events within this window become one job listing them all (“10m”, “30s”) |
enabled? |
boolean | |
every? |
integer | minutes between polls (a polled source) |
factory? |
string | the software factory its own prompt runs through (ADR-0114; a declared task: says its own) |
followUp? |
boolean | or a follow-up to the task the event came from |
header? |
string | webhook: the header that signs each call (X-Hub-Signature-256, Sentry-Hook-Signature, Linear-Signature, X-PagerDuty-Signature): an HMAC-SHA256 of the body under the secret, hex, with or without sha256=/v1=. With it the secret is never sent, only checked. |
if? |
string | an expression over event (event.payload.branch == 'main'), as workflows’ if |
label? |
string | an issue’s or PR’s label |
match? |
object | any other field of the source, matched against the event’s payload (a string, a glob, or a list) |
mode? |
string | plan | edits | auto |
model? |
string | |
on |
string | the source: schedule, once, webhook, manual, or an event type (task.finished, pr.opened, chat.message, …) |
project? |
string | the project it watches, and the folder its task runs in |
prompt? |
string | or a prompt of its own: {event.summary}, {event.payload.x} are filled in |
rate? |
string | at most this many runs: “5/h”, “20/d” |
secret? |
string | webhook: its secret, as ${secret:NAME} |
task? |
string | the declared task it starts (its {params} from the event) |
tz? |
string | schedule and when: an IANA zone (“Europe/Zurich”); this computer’s by default |
users? |
[string] | chat.message: who may (names or ids; anyone for an open channel) |
when? |
trigger.When | |
workflow? |
string | or a workflow runs, with the event as its input |
trigger.Budget
What a trigger may spend.
| Field (? optional) | Type | What it is |
|---|---|---|
perDay? |
number | USD a day, across its runs |
perRun? |
number | USD a run (the run is stopped past it, by wisp.budget’s guard) |
trigger.When
When a trigger may run: outside these, an event is skipped or queued until the window opens.
| Field (? optional) | Type | What it is |
|---|---|---|
days? |
[string] | mon tue wed thu fri sat sun (every day when empty) |
hours? |
string | “9-17” (local hours, start inclusive, end exclusive) |
outside? |
string | skip (default) | queue |
tz? |
string |
ui: (ui)
How wisp looks on this device.
| Field (? optional) | Type | What it is |
|---|---|---|
editor? |
string | the editor files open in (code, cursor, zed) |
keys? |
map of string | key → action |
layout? |
panel sizes and what’s open | |
readTimes? |
boolean | show read times on answers |
terminal? |
string | the terminal app |
theme? |
string | light | dark | system |
transcript? |
string | compact | full |
view? |
string | list | board |
workflows: (workflow)
A workflow: its steps by name, and what bounds a run.
| Field (? optional) | Type | What it is |
|---|---|---|
budget? |
{ usd: 20 }: no new step starts once the run has cost this much |
|
concurrency? |
integer | at most this many steps run at once (0: no limit) |
description? |
string | |
inputs? |
object | values a run takes (wisp run release-check version=2.1), with their defaults |
on? |
what starts it by itself ({ trigger: nightly }); by hand otherwise |
|
project? |
string | the folder its steps run in unless they say |
tasks |
map of workflow.StepSpec |
workflow.StepSpec
One step of a workflow: a task spec plus when it runs.
| Field (? optional) | Type | What it is |
|---|---|---|
agent? |
string | an agent profile’s name or a harness |
effort? |
string | |
goal? |
||
if? |
string | run only when this is true: ${{ tasks.tests.output.failed > 0 }} (skipped otherwise) |
matrix? |
map of [any] | one run per combination: { agent: [claude, codex] } |
mode? |
string | plan | edits | auto |
model? |
string | |
needs? |
[string] | steps that must end first |
on? |
string | the computer it runs on (a machine’s name; ‘’ = this one) |
optional? |
boolean | a failure doesn’t fail the run (the steps after it still see it failed) |
output? |
its output’s shape (a JSON Schema); without one, the output is what its answer gives | |
project? |
string | the folder it runs in (default: the run’s) |
prompt |
string | what to do; ${{ tasks.<step>.output.<field> }}, ${{ inputs.<name> }} and ${{ matrix.<key> }} are filled in |
retries? |
integer | tries again this many times when it fails |
steps? |
[string] | prompts after the first, each when the turn before ends |
timeout? |
integer | minutes it may run before it is stopped and counts as failed |
worktree? |
boolean |