CLI Reference
The complete dl command surface. If you're new, start with the
worked examples in Your First Episode — this page
is the reference you come back to.
The canonical, per-command reference lives at
cli.dreamlake.ai — it versions with each CLI
release (the version switcher pins any past release), covers the newer
command groups (agents, skills, sources, snapshots, lakeshore resources),
and documents both install channels: the native installer and
npm install @dreamlake/dreamlake-cli. The summary below covers the core
commands; for anything not listed here, go there.
Use dl for new commands. The longer dreamlake command remains supported.
For installation, automatic setup on existing machines, and command conflicts,
see CLI installation. Add --debug before any command
to target local dev servers instead of production.
Auth
Files
Upload flags: --type <override>, --bindr <names> (comma-separated,
auto-created). <target> uses the
episode syntax [namespace@]project[:episode].
Collections
Artifacts
Renderable documents — HTML, React, Markdown, SVG, Mermaid, or code — rendered
live in the dashboard at /<namespace>/artifacts. New here? The
Artifacts guide is the two-minute picture-book version. Each artifact is its own
versioned dataset; the DreamLake server keeps the catalog (title, kind,
visibility) that powers the gallery and list.
Kinds: html · react (must define an App component) · markdown · svg ·
mermaid · code. Re-push with the same --id to append a new version — the
viewer keeps every version. After a successful push the CLI prints an open
link to the artifact, so you can click straight through to view what you just
uploaded.
Visibility & sharing. Artifacts are private by default (visible only to
namespace members). --visibility public makes one readable by anyone;
--share mints a ?share=<token> link that any signed-in DreamLake user
can open (anonymous visitors are sent to log in first). Members can also toggle
visibility and copy a share link from the artifact's page in the dashboard.
Delete, Trash & restore. delete is a soft delete: the artifact moves
to your gallery's trash tab (share links stop working immediately), and you
can bring it back with restore, the Restore button in the Trash, or simply by
re-pushing the same --id. delete --permanent (v0.4.14+) permanently
erases the artifact — every version, its stored content, and its catalog
entry. There is no undo; the dashboard's equivalent is Delete forever in
the Trash. With a server that includes the issue #1343 fix (not yet released),
both remove the artifact from every project it was filed in, and a restore
does not re-file it.
Add the artifacts skill (Claude)
DreamLake publishes a Claude skill that teaches
your agent to prepare, publish, version, and share artifacts for you. It is
written in the public
dreamlake-skills repo and
installed by the CLI:
dl skill update brings in new releases without touching files you
have edited. Without the CLI, download skills.tar.gz from the latest
dreamlake-skills release
and copy dreamlake-artifacts/ and dreamlake-cli/ into ~/.claude/skills/
(or a project's .claude/skills/).
Then ask Claude something like "push this dashboard as a dl artifact
and make it public" — it will invoke the skill and run the right
dl artifact commands.
Scenes
Versioned scenes — a directory holding one MJCF scene or one URDF
robot plus its assets, viewed as a live, interactive 3D page at
/<namespace>/scenes. New here? The
Scenes guide is the picture-book version. Each scene stores its files
content-addressed, so re-pushing uploads only what changed, and pull returns
a byte-identical directory (every file is hash-verified).
Names are namespace/scene-name with immutable integer versions — re-push the
same name to append the next version, and the viewer keeps a version picker.
Limits per version: ≤ 1000 files, ≤ 100 MiB per file, ≤ 1 GiB total; dot-files,
node_modules and symlinks are skipped.
Renamed: before scenes existed,
dl envswitched login environments. That command is nowdl auth env list|use|remove— see Environments.
The CLI itself
Note the name: update edits bindrs and datasets, self-update updates the
CLI. See the install reference for the install layout, release channels,
and the variables that switch auto-update off.