Guides

Task-oriented recipes and integrations for DWE. Each page solves a concrete user-facing problem rather than describing a single command or config field.

Guides sit alongside the reference (schemas, command surface, template engine) — the reference tells you what exists, guides tell you how to use it together.

Pages

Starting and joining a project

For developers bootstrapping a new project or getting productive in an existing one.

• Starting a new project with dwe init — no workspace.yml yet; scaffold a minimal-but-complete project that validates clean on the first run.
• Joining a DWE project — you cloned a repo with a workspace.yml; what to run first and what ends up on disk.
• Daily workflow — the small handful of commands you reach for every day: status, services, shell, commands, logs, stop/restart.
• Troubleshooting — your stack misbehaves; a triage map from dwe validate and dwe logs down to dwe compose raw.
• Switching tasks with snapshots — save your current environment, switch to other work, and restore it later; the snapshot create/restore cookbook.

Authoring and maintaining a project

For developers who write DWE config — author services, commands, daemons, snapshot workflows, theming, localization, IDE template packs, preflight checks.

• Adding a service — wire a new worker (or app, or infra) service into an existing project.
• Authoring project commands — turn README incantations into first-class dwe <id> commands.
• Background daemons — declare a long-running queue worker, watcher, or scheduler with type: daemon.
• Preflight checks — fail fast before a deploy touches the machine, with a useful diagnostic.
• Shared IDE and agent config — same VS Code, AGENTS.md, and git hooks for everyone via template packs.
• Localize for your team — translate user commands and command-browser strings into RU / DE / FR / …
• Brand your project — customize the ASCII header, palette, and dwe info dashboard.
• Write snapshot workflows — author workspace/snapshot.yml: decide what gets captured, restored, and cleaned up.
• Writing integration tests — author workspace/tests/*.yml scenarios: isolated deploy tests, assertions, testing project commands, debugging with --keep.

Integrations

• Starship prompt integration — render a compact, project-aware DWE segment inside your Starship shell prompt.

See also

• Reference (reference/) — schemas, config fields, render packs, docs subsystem
• Run dwe --help (or any subcommand with --help) for the live CLI surface
• Run dwe docs for an interactive browser over the whole documentation tree