DocumentationCommands

Commands

A compact everyday overview. Examples do not replace prerequisites or confirmations; complete options and failure contracts remain in the technical reference.

Use this overview

Run project commands from the project directory. Use the linked guide for the standard workflow and the technical reference for complete flags and limits.

  • Examples require active roles and the stated prerequisites.
  • Import and restore can change data or configuration; review their preview or confirmation.

Projects

dwell init

Create a project with roles, configuration and local directories.

Example: initbash
dwell init my-project

dwell import

Analyze existing code; --json writes no project files.

Example: importbash
dwell import --json

dwell build

Prepare workspace dependencies and development images.

Example: buildbash
dwell build

dwell up

Start the project and perform missing preparation when needed.

Example: upbash
dwell up

dwell down

Stop the project while retaining persistent data.

Example: downbash
dwell down

dwell remove

Remove runtime while keeping source. Deleting backend volumes is an explicit prompt and deletes the database.

Example: removebash
dwell remove

dwell reinit

Repair metadata after a physical move; keep the slug by default.

Example: reinitbash
dwell reinit

dwell projects

List known projects from the local registry.

Example: projectsbash
dwell projects

Status & diagnosis

dwell ps

Inspect project runtime, process and LAN status.

Example: psbash
dwell ps

dwell access

Show configured URLs without checking reachability. Explicit database queries can reveal project passwords.

Example: accessbash
dwell access

dwell doctor

Check tools, Docker, gateway and configured HTTP routes.

Example: doctorbash
dwell doctor

dwell logs

Follow relevant logs; find available Dwell logs without an argument. Review output before sharing.

Example: logsbash
dwell logs frontend

dwell plan

Preview planned actions and observed blockers without changes; no startup guarantee.

Example: planbash
dwell plan up

Configuration

dwell config

Inspect project configuration; config opens general editing.

Example: configbash
dwell config show

dwell stack

Change roles and runtime in a stopped project; example requires a compatible backend.

Example: stackbash
dwell stack set --php 8.4

dwell routing

Manage routes with ID, target, host and URL path.

Example: routingbash
dwell routing list

dwell services

Inspect or toggle configured optional backend services.

Example: servicesbash
dwell services list

dwell paths

Move a role directory in a stopped project; this example previews only, and the target must be empty or absent.

Example: pathsbash
dwell paths move backend api --dry-run

Data

dwell db export

Export the database as SQL without overwriting existing files.

Example: db exportbash
dwell db export backups/before-update.sql

dwell db import

Replace the current database from SQL after confirmation and a safety snapshot.

Example: db importbash
dwell db import backups/before-update.sql

dwell db snapshot

Save a named database snapshot; use new names for further snapshots.

Example: db snapshotbash
dwell db snapshot before-update

dwell db restore

Restore a named snapshot, replacing the current database after confirmation.

Example: db restorebash
dwell db restore before-update

dwell backup

Refresh the fixed local SQL backup; unlike db export, replaces the existing backup.

Example: backupbash
dwell backup

Workflow & output

dwell handoff

Check a clone’s local readiness; transfers no data or secrets.

Example: handoffbash
dwell handoff

dwell artifact

Create separate production files for supported stacks; no deployment.

Example: artifactbash
dwell artifact

Tools

dwell open

Open the primary project URL in a browser without checking running state.

Example: openbash
dwell open

dwell ssh

Open a shell in the running backend container. ssh frontend only prints its directory path.

Example: sshbash
dwell ssh backend

dwell run

Run a program in an active role; the backend needs a running container.

Example: runbash
dwell run backend -- php -v

dwell watch

Start a configured backend watcher; currently Shopware only, with its PHP container running.

Example: watchbash
dwell watch

dwell versions

List available stack and PHP version lines.

Example: versionsbash
dwell versions list

dwell version

Show the installed Dwell version; --version shows it without the CLI header.

Example: versionbash
dwell version

Next steps

Start with the projects guide or investigate a failure with troubleshooting.

Technical reference

Complete command contract ↗