- name
- preview-my-work
- description
- Boot, reopen, update, or reset OpenWork PR previews. Discover script worlds; choose preview-desktop (app only), preview-den (Den only), preview-full (Den plus desktop), or preview-app-web locally, on a private Daytona URL, or on Freestyle for hands-on testing.
# Preview my work
Use the repository's world lifecycle. These are disposable test environments,
not production or a user's installed desktop profile. Do not touch another
world or an existing test sandbox. Run from the requested worktree.
## Agent quick path
Three calls take you from intent to a running preview; each prints what the
next one needs.
1. `pnpm world help <world> --json`: each target's seeds and sources, what an
omitted `--source` means, the login or key each placement needs with its
fix, and ready-to-run commands by intent. Remote desktop and Den previews
default to the current `origin/dev` commit (the source the alpha channel is
built from), so "the latest alpha" needs no `--source` there; the per-target
`defaultSource` shows where a source is required instead. `pnpm world help
--json` lists every world with a one-line summary.
2. `pnpm world plan <world> --place <place> --stage <stage>`: checks those
requirements without creating anything and exits 1 with the fix while one is
unmet. `pnpm world outputs <world> --stage <stage> --json` answers
`{"exists": false}` when there is nothing to reopen.
3. `pnpm world up ...` from an example. It checks the requirements again before
any side effect and prints the exact command to rerun.
A refused `--seed` names the worlds and placements that offer it.
### Credentials, scoped to one command
Load keys only inside a command substitution on the one command that needs
them, from the repo root; never print a value.
- Daytona, team organization (preferred):
`DAYTONA_API_URL=https://app.daytona.io/api DAYTONA_API_KEY="$(infisical secrets get DAYTONA_API_KEY --env dev --path /openwork-ops --plain --silent)" pnpm world up ...`.
Both variables are required: the Daytona CLI **silently ignores
`DAYTONA_API_KEY` without `DAYTONA_API_URL`** and falls back to whatever the
CLI is logged into, often a personal organization with a 10 GiB memory cap
and none of the team's warm snapshots. The alternative is a person running
`daytona login` interactively.
- Freestyle:
`FREESTYLE_API_KEY="$(infisical secrets get FREESTYLE_API_KEY --env dev --path /openwork-ops --plain --silent)" pnpm world up ...`.
- Never run `daytona login --api-key ...` for a world: it replaces the person's
CLI login for every tool on the machine. If a lookup printed `*not found*`
(Infisical CLI 0.28.x exits 0 on a missing secret), stop; do not pass it on.
- Do not wrap world commands in `infisical run --env dev -- ...`. It injects
about 21 unrelated secrets, omits `DAYTONA_API_URL` (so the Daytona key is
ignored), and every local Den or desktop process the world starts inherits
them.
### Read what the CLI reports
- `plan --place daytona` prints which identity it will use, e.g. `using the
API key in this command's environment (DAYTONA_API_KEY)` or `using your
Daytona browser login, organization "..."`. A ⚠ on a personal organization or
an ignored key does not block, but fix it before a multi-sandbox preview such
as `preview-full`.
- `up` and `plan` print `source <short sha> (origin/dev) <subject>`: that is
the commit the remote world builds. Report it to the user with the preview
link without being asked.
- A `note this checkout's world recipes differ from <sha> ...` line means the
driver runs this checkout's (possibly stale) recipes against a newer build.
Before launching, run from the worktree command it prints, unless the user
asked to preview this checkout's recipes.
- A failed `up` appends `hint:` lines for recognised causes (Daytona memory
limit, rejected credentials, CLI/API version mismatch); act on them rather
than retrying unchanged.
## Choose a preview
- Discover the actual primitives first: `pnpm world help <world> --json` and `pnpm world list --json` (declared targets are shown; undeclared scripts cannot run remotely),
then inspect the requested script in `worlds/` and its options in `worlds/lib/`.
A preset's restrictions are not restrictions of the generic world CLI.
For another composition, inspect `packages/world/src/index.ts` and
`evals/packages/env/src/index.ts` before declaring it unsupported; reuse the
existing provisioning, runtime launch and hold primitives, not another framework.
- To check your own app change on this computer, start with
`pnpm world up dev-app-web --detach -- --browser`: this checkout's app in
headless Chrome with a `cdp` address to drive (`drive-desktop-cdp`), nothing
on screen. Any `--place local` world with a desktop below opens a window that
takes focus here; use one only when asked or when the change needs the
desktop shell, otherwise run it on Daytona.
- `preview-desktop`: **the desktop app alone**: no Den, organization, workspace
or sign-in, exactly like a fresh install. From source (a pushed SHA on
Daytona/Freestyle, this checkout locally) or exact published release bytes
(`blank`, Daytona Linux or Windows). One sandbox, so it is the cheapest desktop
preview. On `--place daytona` this is Linux Electron in a noVNC viewer, not a
macOS/Windows parity check. `--place local` opens a native window here.
- `preview-den`: **Den alone** (no desktop): signup, team administration,
onboarding, connectors, policies.
- `preview-full`: **Den plus a desktop wired to it**: workspaces, chat, native
app interactions against a seeded org. Two sandboxes on Daytona. Local runs
Den on the local MySQL/Redis and the desktop as a native window.
- `preview-app-web`: configurable source web app plus the isolated server it
needs, locally or on an owned private Daytona sandbox. This is not Den's web
UI and not the Cloud-off `seed.appWeb` test fixture. No Den or activation is seeded.
- `preview-workbot`: **Workbot with what it runs on**: the seeded Acme Den
(sign in as alex@acme.test), the headless runner and the Workbot app, with
Workbot and headless Automations turned on. The model is the deterministic
Acme upstream and the runner's computer is off, so no paid or Freestyle key
enters the world. Local, Daytona (Den sandbox plus one private sandbox for
the runner and Workbot) and Freestyle (`--source ref:dev`); every placement
signs in through Den and gets a runner answer before reporting ready. On
Freestyle, open the `workbotUrl` link: it authorizes Den and Workbot together.
- Freestyle supports `preview-app-web`, `acme-web`, `preview-workbot`, and
`preview-desktop` (signed-out `fresh` only); `preview-den` and `preview-full`
do not run there.
To turn on an app setting such as the v2 engine, export it and select it with
`--env` **before** `--`; desktop previews on local and Daytona pass selected keys
to the app and list them in the `appEnv` output. Freestyle refuses `--env` for
desktops because its snapshot starts the app at build time.
```sh
OPENWORK_ENGINE_V2_PREVIEW=1 pnpm world up preview-desktop --place daytona --stage pr-1234-v2 --detach --env OPENWORK_ENGINE_V2_PREVIEW
```
For the isolated `preview-den`/`preview-full` presets, choose `--scenario fresh`
for signup/first use, `team` for an owner with the demo apps and real
connectors, `restricted` for that team with the API's canonical restricted
policy values, or `workspace` for that team signed in on the desktop. Every
seeded org (not `fresh`) gets demo Slack, Notion, Linear, Google Calendar and
Gmail connections: realistic Acme Robotics data where the person is Alex Chen,
readable and writable in memory (`worlds/lib/demo-workspace.ts`), so a demo can
post, create and read back. Restarting the world restores the seed; locally,
`demoState` shows the live data. `acme-web` (local, Daytona and Freestyle)
gets the same demo apps, so a Freestyle demo uses `acme-web`. Seeded desktops
and web runtimes treat their world's Den as activated, so the demo apps appear
as their own apps on every placement. Real `Notion (live)` and `Linear (live)`
OAuth connectors sit next to them (unconnected), and more real connectors can
be added from Den as usual. Fresh desktop is a
true first launch: the harness adds no workspace and does not sign into Den.
Because the preview's own Den is configured through a bootstrap file, the app
behaves like a bootstrapped install and skips the public-download "OpenWork
Chat" starter workspace, so the sidebar shows no workspaces. No model credentials are seeded.
Do not describe these fixtures as capable of live model/provider requests.
For `preview-desktop`, use `--scenario blank --release <x.y.z> --distribution <name>` to preview exact
published Linux x64 tarball bytes with a completely isolated, unseeded profile.
Add `--os windows` before `--` to preview the published Windows x64 installer
in a private Windows Daytona VM. Windows launches as the logged-in Administrator
through a world-owned interactive task (never SYSTEM/session 0); its private
noVNC viewer and CDP are probed before reporting readiness. Supported
distributions are `public`, `cloud`, and `enterprise`; arm64, prereleases,
mutable/latest versions and Windows source previews are not supported.
Windows accepts `--lifetime 0-1410` (0 until stopped), reserving 30 minutes
for a VM provider TTL after startup. The installer resolves the exact `v<x.y.z>` GitHub release asset and verifies
its API-published SHA-256 digest inside the VM before installation.
## Saved web evidence checkpoints
Checkpoint images appear in the PR's normal **OpenWork Evidence** report (specs
tagged `checkpoints` run with `--checkpoints` in CI's protected checkpoint lane).
Pictures with a saved world offer **Open from here** below the image and in its
viewer, then **Enter saved browser**. Both places share the same copy; **New copy**
restores the original checkpoint again without reloading the report. Only explicit
checkpoints (`user.checkpoint()`, `step(..., { checkpoint: true })`, and the end
state of tests tagged `checkpoints`) are saved; ordinary screenshots, opened copies,
review UI and noVNC-client images are screenshot-only. This creates an independent private VM;
it never resumes or changes the original test VM. The captured Chromium tab is
shown through noVNC. A held mock response offers **Continue response**. Do not
promise restoration of a live connection to an external model provider.
To run the opt-in proof from the requested branch:
```sh
pnpm --filter @openwork/review-app build
pnpm evals:e2e web-checkpoint-fork --local --engine v1 --surface web --checkpoints
```
`--local` places the test controller and review browser locally (Blacksmith in
CI); the explicit evidence world runs wholly on Freestyle. The host needs
`FREESTYLE_API_KEY`; it must never enter the VM or an evidence artifact. Ordinary
proofs are unchanged. This does not require an Infisical integration.
To inspect a new web world rather than a captured step, use the merged world
source vocabulary; all components use that one pushed commit:
```sh
pnpm world up ./packages/freestyle/worlds/evidence-web.ts --place freestyle --stage pr-1234 --source app-web=sha:<full-pushed-sha>
pnpm world outputs evidence-web --stage pr-1234 --reveal
pnpm world down evidence-web --stage pr-1234
```
Do not substitute that fresh world for a checkpoint. Checkpoints expire after
24 hours; forks last one hour, with three simultaneous copies per checkpoint.
Keep access links private. Cold preparation and snapshot materialization can
still take minutes. The PR proof publishes a separate protected review preview
from its own head, without updating the shared reviewer or requiring a merge.
## Start and open
For the configurable web app, use a reviewed full pushed SHA on Daytona:
```sh
pnpm world up preview-app-web --place local --stage pr-1234
pnpm world up preview-app-web --place daytona --stage pr-1234 --detach --timeout 600000 -- --ref <full-pushed-sha>
pnpm world outputs preview-app-web --stage pr-1234 --reveal
pnpm world down preview-app-web --stage pr-1234
```
An existing Den proxy is an explicit, nonsecret environment selection, not a
`--cloud` mode. Set values in the caller and select each key with repeatable
generic `--env KEY` **before** the script-argument separator:
```sh
OPENWORK_DEV_HEADLESS_WEB_DEN_PROXY=1 \
OPENWORK_DEV_DEN_PROXY_TARGET=https://app.openworklabs.com \
pnpm world up preview-app-web --place daytona --stage pr-1234 --detach --timeout 600000 \
--env OPENWORK_DEV_HEADLESS_WEB_DEN_PROXY --env OPENWORK_DEV_DEN_PROXY_TARGET \
-- --ref <full-pushed-sha>
```
Without those selections app-web ignores ambient proxy settings and stays
Cloud-off. Only these two app keys are accepted; the target must be a nonsecret
HTTP(S) origin, selected together with an enabled proxy. Remote app-web initially
allows only `https://app.openworklabs.com`; other targets fail before provisioning.
Local app-web allows custom HTTP(S) origins, including loopback. Direct script
execution without the CLI selection marker stays Cloud-off.
Generic invocation identity fingerprints the selected nonsecret values
before adoption; changing a key, value, placement or script argument requires a
new stage or explicit down. Never pass provider credentials, host/client tokens,
personal profiles, or shared secrets volumes. There is no `--cloud` flag.
The CLI rejects credential-like environment key names. Local invocation identity
also hashes Git HEAD, status, tracked diffs and untracked file names/content;
source changes require a new stage or down before up, across local worlds.
The app-web `webUrl` is a secret, port-bound signed hostname. Reveal it only in a
private terminal and open it directly; never put it in evidence or PR text.
Loopback `runtimeWebUrl`/`runtimeOpenworkUrl` are process diagnostics, not human
browser links. Source SHA and placement are explicit outputs. Private HTTP,
assets and WebSocket access must pass the launch checks; failures delete the
owned sandbox, never fall back to public exposure. The source dev proxy preserves
client bearer auth and never injects host auth. Builds and production preview
servers do not enable this proxy. Checked-out source receives only the non-secret
preview host suffix for Vite allowedHosts, never the signed origin. HMR derives
its host and protocol from the browser location; `/api/openwork` resolves against
that same origin in the browser. Signed URLs stay in the trusted launcher,
witness and private outputs.
Do not claim sign-in is verified. Production handoff rules are unchanged and
arbitrary preview-origin auto-return is not approved. The existing app sign-in
surface has **Paste sign-in code**; if the existing Den flow supplies a one-time
code, paste it directly there. Do not fabricate activation/bootstrap state.
App-web defaults to two hours from readiness; optionally pass `--lifetime <10-1430>`
after `--`. Its signed URL is issued by the trusted launcher before runtime launch, with the
lifetime plus a ten-minute startup buffer (within Daytona's 24-hour maximum).
Startup exceeding that buffer fails closed. `expires` is the authoritative world
deadline from readiness; `previewExpires` is the conservative URL deadline from
issuance. The URL credential can outlive the world timer, but sandbox deletion
invalidates access. World expiry or `down` tears
down the owned runtime and sandbox while the owning driver is running. Always
explicitly stop when finished. Abrupt driver crashes can leave a sandbox behind:
ledger ownership is not authenticated, so no Daytona ledger reaper is registered.
Manual cleanup must independently verify ownership before deleting a sandbox.
The preset update helper below
does not update app-web; use a new stage on the next reviewed SHA instead.
Daytona documents signed hosts as `{port}-{token}.{proxyDomain}`, not sandbox-ID
hosts (https://www.daytona.io/docs/en/preview/). The launcher checks structured
private sandbox info (matching ID, `public: false`) and its `toolboxProxyUrl`
(`https://{proxyDomain}/toolbox`) before
issuing the signed URL; unsupported info formats fail closed. It rejects standard
sandbox UUID hosts and mismatched domains. The opaque signed token cannot prove
sandbox identity by hostname alone; issuance is scoped to the verified sandbox ID.
The following scenario/ref and update instructions concern the isolated presets.
Use a unique stage such as `pr-1234` to keep previews separate. First inspect
`pnpm world list` and `pnpm world outputs <world> --stage <stage> --json`.
An existing matching world should be reopened, not recreated. Compare its
recorded scenario and ref before adopting it. A stage is not a git ref.
Use reviewed repository code: previews execute that ref’s build scripts. Do not
load production credentials or attach shared secrets volumes. Push the intended
commit and use its full 40-character SHA so Daytona can fetch it. When
`OPENWORK_EVAL_REF` is omitted, launch resolves remote `origin/dev` once to a
full SHA, prints it, and records it in the world outputs. This assumes `dev`
is the reviewed baseline. Explicit launch refs and update refs still reject
mutable branch names. To preview a specific commit:
```sh
OPENWORK_EVAL_REF=<pushed-sha> \
DAYTONA_API_URL=https://app.daytona.io/api \
DAYTONA_API_KEY="$(infisical secrets get DAYTONA_API_KEY --env dev --path /openwork-ops --plain --silent)" \
pnpm world up preview-den --stage pr-1234 --place daytona --detach --timeout 600000 -- --scenario fresh --lifetime 120
```
Omit the two Daytona variables when the person's own `daytona login` is the
intended identity; `plan --place daytona` shows which one applies.
Substitute `preview-full` or `preview-desktop` and the desired scenario as needed. The existing
Daytona snapshots handle dependencies. A cold build takes minutes; reopening a
ready world is quick. Never promise seconds for an unmeasured cold boot.
For an immutable published desktop preview, run:
```sh
pnpm world up preview-desktop --stage pr-1234 --place daytona --detach --timeout 600000 -- --release 0.18.44 --distribution enterprise --scenario blank
# Windows published x64, with a private signed viewer:
pnpm world up preview-desktop --stage pr-1234-win --place daytona --os windows --detach --timeout 600000 --source desktop=release:0.18.52/enterprise --seed blank
pnpm world outputs preview-desktop --stage pr-1234-win --reveal
```
For a published release, `OPENWORK_EVAL_REF` pins only the preview tooling that
installs and launches the release; omit it to use the current remote `dev`
commit, independently of the desktop version. No Den is created.
The world driver and release installer run from the local checkout's HEAD, and
the desktop sandbox uses the snapshot's inherited display/browser helpers.
`--release` selects desktop bytes; none of these identities falls back to
another. For preview recipes only, the equivalent composable inputs before `--`
are `--source desktop=release:0.18.52/enterprise --seed blank`, or
`--source desktop=sha:<full-pushed-sha>` for a source build.
Do not combine `--source desktop=...` with `-- --release`. A `ref:` source
(for example `--source den=ref:dev` on `preview-full`) resolves to a full SHA
before adoption; otherwise the CLI pins the remote dev SHA for Daytona previews. For Windows, add `--os windows` before
`--`, or use the composable source/seed syntax above; only exact blank published
Windows x64 releases are supported. Freestyle does not support Windows. On
Freestyle, `preview-desktop` supports only the signed-out `fresh` desktop from a
pushed commit (`pnpm world up preview-desktop --place freestyle --source desktop=ref:dev`);
it has no Den, so `blank`, `preview-den` and `preview-full` are refused. Release sandboxes do not mount shared secrets and do not run a
source checkout, `pnpm install`, Electron source launch, or Vite. Their viewer,
startup observation, release digest and log/profile paths are outputs.
Linux additionally reports relaunch/browser shortcuts and a protocol handler. A
crashed or unresponsive app is retained for inspection and is not reported as
healthy; CDP is output only when it actually responded.
Read the resulting world outputs. Open `preview` with Codex's `open_in_codex`
browser target when available; do not launch the operating system browser.
Den opens directly; desktop opens the noVNC viewer with automatic connection,
fit-to-panel scaling and reconnect enabled. The viewer toolbar includes
clipboard controls. Keep `denWeb` available for testing both surfaces.
If this agent has no embedded-browser opening tool, give the preview link.
For phone web layouts, use the browser tool's viewport controls if available;
otherwise use the preview's responsive browser tools. Do not call a resized
Electron viewer a mobile app preview.
Wait for world readiness and verify the preview responds before reporting it
ready. If testing behavior, follow `run-tests`; a manually booted world is not a
passing test. Do not print secret outputs or put them in a PR. Test account
passwords are masked; read the owner-only receipt privately when signing in.
For seeded Den scenarios, use the available browser controls to sign in with
that test account before handing the preview to the user. Leave fresh Den at
signup. The `preview-full` team/workspace scenarios already sign in automatically.
Mail stays in this world's development outbox; never send real invitations.
## Update without losing progress
For frontend-only changes, push the new commit and run:
```sh
pnpm exec python3 .opencode/skills/preview-my-work/scripts/update-preview.py preview-den --stage pr-1234 --ref <pushed-sha>
```
For `preview-full`, the helper updates both Den web and the desktop renderer;
for `preview-desktop` it updates the desktop renderer only.
It preserves the Den database, accounts, Electron process and profile. Desktop
renderer updates use the existing Vite hot reload; reload the viewer/app if
needed. Verify the changed screen before claiming the update is visible.
The update helper rejects published release previews. Stop that exact stage and
launch a new stage/version instead; changing source cannot change published
desktop bytes.
Ver no GitHub