Skip to content

Commit 4e111d3

Browse files
committed
docs(nerdctl-compose): add missing details in command-reference.md
Signed-off-by: Subash Kotha <[email protected]>
1 parent 8e9e464 commit 4e111d3

File tree

1 file changed

+25
-0
lines changed

1 file changed

+25
-0
lines changed

docs/command-reference.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1410,6 +1410,7 @@ Flags:
14101410

14111411
- :whale: `-f, --file`: Specify an alternate compose file
14121412
- :whale: `-p, --project-name`: Specify an alternate project name
1413+
- :whale: `--project-directory`: Specify an alternate working directory
14131414
- :nerd_face: `--ipfs-address`: Multiaddr of IPFS API (default uses `$IPFS_PATH` env variable if defined or local directory `~/.ipfs`)
14141415
- :whale: `--profile: Specify a profile to enable
14151416
- :whale: `--env-file` : Specify an alternate environment file
@@ -1451,6 +1452,7 @@ Flags:
14511452

14521453
- :whale: `--no-color`: Produce monochrome output
14531454
- :whale: `--no-log-prefix`: Don't print prefix in logs
1455+
- :whale: `-f, --follow`: Follow log output.
14541456
- :whale: `--timestamps`: Show timestamps
14551457
- :whale: `--tail`: Number of lines to show from the end of the logs
14561458

@@ -1525,6 +1527,7 @@ Usage: `nerdctl compose images [OPTIONS] [SERVICE...]`
15251527
Flags:
15261528

15271529
- :whale: `-q, --quiet`: Only show numeric image IDs
1530+
- :whale: `--format`: Format the output. Supported values: [json]
15281531

15291532
### :whale: nerdctl compose start
15301533

@@ -1675,6 +1678,28 @@ Run a one-off command on a service
16751678

16761679
Usage: `nerdctl compose run [OPTIONS] SERVICE [COMMAND] [ARGS...]`
16771680

1681+
Flags:
1682+
1683+
- :whale: `--build`: Build images before starting containers.
1684+
- :whale: `-d, —detach`: Detached mode: Run containers in the background.
1685+
- :whale: `--entrypoint`: Overwrite the default ENTRYPOINT of the image.
1686+
- :whale: `-e, —env`: Set environment variables.
1687+
- :whale: `-i, —interactive`: Keep STDIN open even if not attached (default true).
1688+
- :whale: `-l, —label`: Set metadata on container.
1689+
- :whale: `--name`: Assign a name to the container.
1690+
- :whale: `--no-build`: Don't build an image, even if it's missing.
1691+
- :whale: `--no-color`: Produce monochrome output.
1692+
- :whale: `--no-deps`: Don't start dependencies.
1693+
- :whale: `--no-log-prefix`: Don't print prefix in logs.
1694+
- :whale: `--publish`: Publish a container's port(s) to the host.
1695+
- :whale: `--quiet-pull`: Pull without printing progress information.
1696+
- :whale: `--remove-orphans`: Remove containers for services not defined in the Compose file.
1697+
- :whale: `--rm`: Automatically remove the container when it exits.
1698+
- :whale: `--service-ports`: Run command with the service's ports enabled and mapped to the host.
1699+
- :whale: `-u, —user`: Username or UID (format: <name|uid>[:<group|gid>]).
1700+
- :whale: `-v, —volume`: Bind mount a volume.
1701+
- :whale: `-w, —workdir`: Working directory inside the container.
1702+
16781703
Unimplemented `docker-compose run` (V1) flags: `--use-aliases`, `--no-TTY`
16791704

16801705
Unimplemented `docker compose run` (V2) flags: `--use-aliases`, `--no-TTY`, `--tty`

0 commit comments

Comments
 (0)