Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -106,6 +106,12 @@ contains your `docker-compose.yml` / `docker-compose.dev.yml`, or a parent of it
> **Platform support.** Every command runs on macOS, Linux and Windows, except `sync`
> (macOS + Windows only) and the `up --separateWindow` flag (Windows only).

> **Non-interactive / AI-agent use.** Commands that would otherwise prompt for confirmation
> accept **`-y, --yes`** to proceed with the defaults without asking: `up`, `restart`, `down`,
> `stop-all`, `test`, `import`, `export`, `open`. Combine with `lab help --json` for a
> machine-readable command overview. (Note: writing the hosts file still needs `sudo`/elevation,
> and Doppler-based apps need a pre-authenticated Doppler CLI — neither can be answered by `-y`.)

### Run & inspect your app

#### `up` (alias `start`)
Expand Down Expand Up @@ -136,6 +142,7 @@ Stops the current application (`docker compose stop`).

#### `down`
Destroys the current app's containers and removes their images if required (`docker compose down`).
- `-y, --yes` — proceed non-interactively (destroy the app; keep the hosts entry).

#### `status` (alias `ps`)
Checks whether the app is currently running.
Expand Down Expand Up @@ -168,6 +175,7 @@ lab sh --shell sh -s
#### `open`
Opens the app's main container in your default browser.
- `-p, --protocol <protocol>` — the protocol to use (default `https`).
- `-y, --yes` — if the app isn't running, start it automatically (non-interactively) and then open it.

#### `sync` _(macOS + Windows only)_
Runs a [unison](#file-sync-unison) sync into your application. Useful when the bind-mount is too
Expand All @@ -188,6 +196,7 @@ Restarts the docker engine.

#### `stop-all`
Stops **all** currently running containers (not just the current app's).
- `-y, --yes` — proceed non-interactively (skip the confirmation).

### Project setup & data

Expand All @@ -211,14 +220,17 @@ repository. Then just run `lab up`.
Triggers the import process using the
[LABOR import/export container](https://github.com/labor-digital/docker-import-export).
- `-c, --copyFromTest` — copy import data from the test-data directory first (**overwrites existing files**).
- `-y, --yes` — proceed non-interactively (skip the confirmation).

#### `export`
Triggers the export process using the LABOR import/export container.
- `-c, --copyToTest` — copy the exported files into the test-data directory if it exists (**overwrites existing files**).
- `-y, --yes` — proceed non-interactively (skip the confirmation).

#### `test`
Runs the test process using the LABOR jest-puppeteer container.
- `-u, --update` — run `test-update` instead of `test` (usually updates reference snapshots).
- `-y, --yes` — proceed non-interactively (skip the confirmation).

#### `installCa`
Installs our root CA ([`@labor-digital/ssl-certs`](https://www.npmjs.com/package/@labor-digital/ssl-certs))
Expand Down
1 change: 0 additions & 1 deletion lib/Classes/Api/DockerCompose.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion lib/Classes/Api/DockerCompose.js.map

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

13 changes: 10 additions & 3 deletions lib/Classes/Command/AbstractImportExportCommand.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading