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
roof init
Create a project with roles, configuration and local directories.
roof init my-projectroof import
Analyze existing code; --json writes no project files.
roof import --jsonroof build
Prepare workspace dependencies and development images.
roof buildroof up
Start the project and perform missing preparation when needed.
roof uproof down
Stop the project while retaining persistent data.
roof downroof remove
Remove runtime while keeping source. Deleting backend volumes is an explicit prompt and deletes the database.
roof removeroof reinit
Repair metadata after a physical move; keep the slug by default.
roof reinitroof projects
List known projects from the local registry.
roof projectsStatus & diagnosis
roof ps
Inspect project runtime, process and LAN status.
roof psroof access
Show configured URLs without checking reachability. Explicit database queries can reveal project passwords.
roof accessroof doctor
Check tools, Docker, gateway and configured HTTP routes.
roof doctorroof logs
Follow relevant logs; find available Roof logs without an argument. Review output before sharing.
roof logs frontendroof plan
Preview planned actions and observed blockers without changes; no startup guarantee.
roof plan upConfiguration
roof config
Inspect project configuration; config opens general editing.
roof config showroof stack
Change roles and runtime in a stopped project; example requires a compatible backend.
roof stack set --php 8.4roof routing
Manage routes with ID, target, host and URL path.
roof routing listroof services
Inspect or toggle configured optional backend services.
roof services listroof paths
Move a role directory in a stopped project; this example previews only, and the target must be empty or absent.
roof paths move backend api --dry-runData
roof db export
Export the database as SQL without overwriting existing files.
roof db export backups/before-update.sqlroof db import
Replace the current database from SQL after confirmation and a safety snapshot.
roof db import backups/before-update.sqlroof db snapshot
Save a named database snapshot; use new names for further snapshots.
roof db snapshot before-updateroof db restore
Restore a named snapshot, replacing the current database after confirmation.
roof db restore before-updateroof backup
Refresh the fixed local SQL backup; unlike db export, replaces the existing backup.
roof backupWorkflow & output
roof handoff
Check a clone’s local readiness; transfers no data or secrets.
roof handoffroof artifact
Create separate production files for supported stacks; no deployment.
roof artifactTools
roof open
Open the primary project URL in a browser without checking running state.
roof openroof ssh
Open a shell in the running backend container. ssh frontend only prints its directory path.
roof ssh backendroof run
Run a program in an active role; the backend needs a running container.
roof run backend -- php -vroof watch
Start a configured backend watcher; currently Shopware only, with its PHP container running.
roof watchroof versions
List available stack and PHP version lines.
roof versions listroof version
Show the installed Roof version; --version shows it without the CLI header.
roof versionNext steps
Start with the projects guide or investigate a failure with troubleshooting.