Skip to content

Add and edit projects

How Dockmaster detects the apps in a folder, and what each app setting does.

desktop guide · 3 min read

A project is a folder plus the apps inside it. Each app has its own folder, commands, environment and ports. Open the editor with New project, or with Edit in a project’s ⋮ menu in the sidebar.

How detection works

When you Browse to a folder, Dockmaster looks up to four levels deep for apps. It skips folders such as node_modules, vendor, dist, build, target, venv and any folder starting with a dot.

  • A folder with one app becomes a one-app project.
  • Monorepos (pnpm-workspace.yaml, turbo.json, nx.json, lerna.json, go.work, npm workspaces or a Cargo workspace) are listed app by app.
  • A Go module with several cmd/ programs, or a Rust crate with several binaries, becomes one app per program.

Click Rescan later to pick up new apps. Apps you already have are skipped.

Supported frameworks

Found Suggested start command
package.json Your dev, start, serve or watch script, run with npm, pnpm, yarn or bun (from the lockfile)
go.mod go run . or go run ./cmd/<name>
Cargo.toml cargo run
pyproject.toml, requirements.txt Django, FastAPI or Flask, or python main.py
*.csproj, *.sln dotnet run
Gradle or Maven bootRun / spring-boot:run for Spring Boot
Gemfile bin/rails server for Rails
composer.json php artisan serve for Laravel
mix.exs mix phx.server for Phoenix
deno.json deno task
pubspec.yaml flutter run
compose.yml, docker-compose.yml docker compose up

Suggestions are a starting point. You can change any command before you save.

App settings

  • App name and Work directory — the folder the app’s commands run in.
  • Default command for Start all — the command Start all runs for this app. It defaults to dev.
  • Commands — named commands such as dev, build or test. Each one gets a row in the commands panel.
  • Environment — variables added to every command of this app.
  • Env file — a .env file to load. Values set under Environment take priority.
  • Ports — the ports the app listens on, such as 3000, 3001. They power the port links in the commands panel and the healthy status.

Ports are freed before an app starts. If another process is already listening on one of an app’s ports, Dockmaster stops that process before it runs the command. Only list ports that belong to this app. Setting a port here does not set PORT for you; add it under Environment if your app needs it.

Reorder and remove projects

Drag a project by its handle to reorder the sidebar. To remove one, choose Delete in its ⋮ menu. Its terminals are closed and the project is removed from Dockmaster; your files are not touched. Stop its commands first, because deleting a project doesn’t stop commands that are still running.

Still stuck?

Get in touch ↗Tell us your Dockmaster version (Settings → Updates), your operating system and the step that didn't work.