Remzona54/compose
1
0
Fork 0
mirror of https://github.com/docker/compose.git synced 2026-08-28 12:23:49 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 4

docs: compose logs: add links for since/until flag descriptions
Some checks failed
ci / validate (lint) (push) Has been cancelled
Details
ci / validate (validate-docs) (push) Has been cancelled
Details
ci / validate (validate-go-mod) (push) Has been cancelled
Details
ci / validate (validate-headers) (push) Has been cancelled
Details
ci / binary (push) Has been cancelled
Details
ci / bin-image-test (push) Has been cancelled
Details
ci / test (push) Has been cancelled
Details
ci / e2e (plugin, oldstable) (push) Has been cancelled
Details
ci / e2e (standalone, oldstable) (push) Has been cancelled
Details
ci / e2e (plugin, stable) (push) Has been cancelled
Details
ci / e2e (standalone, stable) (push) Has been cancelled
Details
docs-upstream / docs-yaml (push) Has been cancelled
Details
merge / bin-image-prepare (push) Has been cancelled
Details
merge / module-image (push) Has been cancelled
Details
Scorecards supply-chain security / Scorecards analysis (push) Has been cancelled
Details
ci / binary-finalize (push) Has been cancelled
Details
ci / coverage (push) Has been cancelled
Details
ci / release (push) Has been cancelled
Details
docs-upstream / validate (push) Has been cancelled
Details
merge / bin-image (push) Has been cancelled
Details
merge / desktop-edge-test (push) Has been cancelled
Details

Browse source 
Link to the corresponding `docker container logs` equivalents, which
contain more details on the accepted formats and use.

The container logs documentation still needs some updates to provide
per-flag sections, so follow-ups can be made once those are done.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
This commit is contained in:
Sebastiaan van Stijn 2026-05-22 13:59:18 +02:00 • committed by Guillaume Lours
parent 40a2262a0f
commit 7eeb7de7a2
3 changed files with 16 additions and 11 deletions
Download patch file Download diff file Expand all files Collapse all files

3
cmd/compose/logs.go
View file

@ -20,6 +20,7 @@ import (
"context"
"errors"
"github.com/docker/cli-docs-tool/annotation"
"github.com/docker/cli/cli/command"
"github.com/spf13/cobra"
@ -63,7 +64,9 @@ func logsCommand(p *ProjectOptions, dockerCli command.Cli, backendOptions *Backe
flags.BoolVarP(&opts.follow, "follow", "f", false, "Follow log output")
flags.IntVar(&opts.index, "index", 0, "index of the container if service has multiple replicas")
flags.StringVar(&opts.since, "since", "", "Show logs since timestamp (e.g. 2013-01-02T13:23:37Z) or relative (e.g. 42m for 42 minutes)")
flags.SetAnnotation("since", annotation.ExternalURL, []string{"https://docs.docker.com/reference/cli/docker/container/logs/"}) //nolint:errcheck
flags.StringVar(&opts.until, "until", "", "Show logs before a timestamp (e.g. 2013-01-02T13:23:37Z) or relative (e.g. 42m for 42 minutes)")
flags.SetAnnotation("until", annotation.ExternalURL, []string{"https://docs.docker.com/reference/cli/docker/container/logs/#until"}) //nolint:errcheck
flags.BoolVar(&opts.noColor, "no-color", false, "Produce monochrome output")
flags.BoolVar(&opts.noPrefix, "no-log-prefix", false, "Don't print prefix in logs")
flags.BoolVarP(&opts.timestamps, "timestamps", "t", false, "Show timestamps")

22
docs/reference/compose_logs.md
View file

@ -5,17 +5,17 @@ Displays log output from services
### Options
| Name | Type | Default | Description |
|:---------------------|:---------|:--------|:-----------------------------------------------------------------------------------------------|
| `--dry-run` | `bool` | | Execute command in dry run mode |
| `-f`, `--follow` | `bool` | | Follow log output |
| `--index` | `int` | `0` | index of the container if service has multiple replicas |
| `--no-color` | `bool` | | Produce monochrome output |
| `--no-log-prefix` | `bool` | | Don't print prefix in logs |
| `--since` | `string` | | Show logs since timestamp (e.g. 2013-01-02T13:23:37Z) or relative (e.g. 42m for 42 minutes) |
| `-n`, `--tail` | `string` | `all` | Number of lines to show from the end of the logs for each container |
| `-t`, `--timestamps` | `bool` | | Show timestamps |
| `--until` | `string` | | Show logs before a timestamp (e.g. 2013-01-02T13:23:37Z) or relative (e.g. 42m for 42 minutes) |
| Name | Type | Default | Description |
|:--------------------------------------------------------------------------------|:---------|:--------|:-----------------------------------------------------------------------------------------------|
| `--dry-run` | `bool` | | Execute command in dry run mode |
| `-f`, `--follow` | `bool` | | Follow log output |
| `--index` | `int` | `0` | index of the container if service has multiple replicas |
| `--no-color` | `bool` | | Produce monochrome output |
| `--no-log-prefix` | `bool` | | Don't print prefix in logs |
| [`--since`](https://docs.docker.com/reference/cli/docker/container/logs/) | `string` | | Show logs since timestamp (e.g. 2013-01-02T13:23:37Z) or relative (e.g. 42m for 42 minutes) |
| `-n`, `--tail` | `string` | `all` | Number of lines to show from the end of the logs for each container |
| `-t`, `--timestamps` | `bool` | | Show timestamps |
| [`--until`](https://docs.docker.com/reference/cli/docker/container/logs/#until) | `string` | | Show logs before a timestamp (e.g. 2013-01-02T13:23:37Z) or relative (e.g. 42m for 42 minutes) |
<!---MARKER_GEN_END-->

2
docs/reference/docker_compose_logs.yaml
View file

@ -50,6 +50,7 @@ options:
value_type: string
description: |
Show logs since timestamp (e.g. 2013-01-02T13:23:37Z) or relative (e.g. 42m for 42 minutes)
details_url: /reference/cli/docker/container/logs/
deprecated: false
hidden: false
experimental: false
@ -83,6 +84,7 @@ options:
value_type: string
description: |
Show logs before a timestamp (e.g. 2013-01-02T13:23:37Z) or relative (e.g. 42m for 42 minutes)
details_url: /reference/cli/docker/container/logs/#until
deprecated: false
hidden: false
experimental: false