Installation

Learn what you need, how to install the current candidate and how to start your first project.

Requirements

Dwell needs Node.js, npm and a running Docker daemon. Also check the selected frontend’s requirements: some stacks need a newer Node version.

Node.js ≥ 20.19.0

Minimum version for the Dwell CLI.

npm in PATH

npm must be available in your terminal.

Docker is running

Docker Desktop or another running Docker daemon.

Installation (RC)

In your terminal, switch to the checked-out Dwell source. Build the package there and install the resulting file globally.

Dwell is an unpublished pre-beta release candidate. Installation currently uses a repository checkout.

Open the Dwell repository

Build the packagebash

npm ci && npm pack

Installs the checkout’s dependencies and creates the local npm package.

Install globallybash

npm install -g ./websign-dwell-1.0.0-rc.1.tgz

This filename belongs to 1.0.0-rc.1. For another version, use the package file actually generated.

Check installationbash

dwell --help

Displays CLI help. If the command is unavailable, check your npm directory in PATH.

First project

Run these commands in your working directory. The “mein-projekt” directory should not already contain another application.

Initialize a projectbash
```
dwell init mein-projekt
```
Creates a new directory. In an interactive terminal, choose backend, frontend and the PHP version when a backend is active.
Prepare the projectbash
```
cd mein-projekt
dwell build
```
Switch to the project directory. Dwell checks the setup, installs managed dependencies and prepares the runtime.
Start the projectbash
```
dwell up
```
Starts the selected roles and registers local routes with the gateway.

Local domains

Without a custom host, the new project is available at mein-projekt.localhost. Use dwell open to open its primary address. You can configure a host independently of the project name.

Open the project addressbash

dwell open

Network

dwell up --lan additionally enables sharing through .local. This depends on the local network, mDNS, firewall and client device. It is not an internet tunnel.

Next steps

Use these topics to configure your project or investigate problems. The full technical reference is maintained in the repository.

Check the environmentbash

dwell doctor

Read CLI commands Configure your project Frequently asked questions

Source: current project documentation