Skip to content

Add notes regarding --log-root to the command reference. #1582

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jglogan merged 1 commit into from
May 22, 2026
+9 −2
Merged

Add notes regarding --log-root to the command reference. #1582

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
11 changes: 9 additions & 2 deletions docs/command-reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
>
> Example: [release 0.4.1 tag](https://github.com/apple/container/tree/0.4.1)

Note: Command availability may vary depending on host operating system and macOS version.
Command availability may vary depending on your macOS version.

## Core Commands

Expand Down Expand Up @@ -896,7 +896,8 @@ container run -v $VOL:/data alpine
container volume rm $VOL
```

**Note**: Unlike Docker, anonymous volumes do NOT auto-cleanup with `--rm`. Manual deletion is required.
> [!NOTE]
> Unlike Docker, anonymous volumes do NOT auto-cleanup with `--rm`. Manual deletion is required.

### `container volume delete (rm)`

Expand Down Expand Up @@ -1054,6 +1055,9 @@ container system start [--app-root <app-root>] [--install-root <install-root>] [
* `--log-root <log-root>`: Path to the root directory for log data, using macOS log facility if not set
* `--enable-kernel-install/--disable-kernel-install`: Specify whether the default kernel should be installed or not (default: prompt user)

> [!NOTE]
> The `--log-root` option is principally intended for short-term test and diagnostic purposes. The log handler for this option neither aggregates log messages, nor does it rotate logs.

### `container system stop`

Stops the container services and deregisters them from launchd. You can specify a prefix to target services created with a different launchd prefix.
Expand Down Expand Up @@ -1151,6 +1155,9 @@ Equivalent to the JSON output but in YAML format. Each entry in the array repres

Displays logs from the container services. You can specify a time interval or follow new logs in real time.

> [!NOTE]
> If you run `container system start with --log-root`, services only write log messages to files under the log root, and `container system logs` will show no service log messages.

**Usage**

```bash
Expand Down