Commit Graph
67 Commits
Author SHA1 Message Date
Guillaume Lours 6bedc196cc update -p project name flag documentation
Signed-off-by: Guillaume Lours <[email protected]>
2023-03-22 10:53:54 +01:00
Nicolas De Loof e831ea826b add support for restart for depends_on
Signed-off-by: Nicolas De Loof <[email protected]>
2023-02-18 12:55:29 +01:00
Nicolas De Loof 9ac0392baf introduce --timeout on up
Signed-off-by: Nicolas De Loof <[email protected]>
2023-02-14 12:16:41 +01:00
Nicolas De Loof 0612b34c68 introduce --no-deps on restart
Signed-off-by: Nicolas De Loof <[email protected]>
2023-02-14 11:30:15 +01:00
Nicolas De Loof 41e056341b rename convert to config to align with compose v1 UX
Signed-off-by: Nicolas De Loof <[email protected]>
2023-01-30 22:23:53 +01:00
Laura Brehm 69c0a583be Merge pull request #10208 from laurazard/add-scale-create 2023-01-27 15:26:01 +01:00
maxcleme 634a7d2a7b Support for docker compose build --push when using multiple platforms
Signed-off-by: maxcleme <[email protected]>
2023-01-26 16:54:41 +01:00
Laura Brehm a288332fbd Update docs to add --scale argument to compose create
Signed-off-by: Laura Brehm <[email protected]>
2023-01-26 13:03:49 +01:00
Nicolas De Loof 33c3f4dfad alias -n for --tail to align with docker CLI
Signed-off-by: Nicolas De Loof <[email protected]>
2023-01-26 10:00:58 +01:00
Laura Brehm d47f0f31c2 Update docs to mention COMPOSE_PARALLEL_LIMITS and ways to configure parallelism
Signed-off-by: Laura Brehm <[email protected]>
2023-01-24 17:01:15 +01:00
Nicolas De Loof 4721c01702 fix docs to reflect docker compose ps being aligned with docker ps
Signed-off-by: Nicolas De Loof <[email protected]>
2023-01-24 11:11:20 +01:00
Guillaume Lours eb59b0e265 add alpha command to test dry-run
Signed-off-by: Guillaume Lours <[email protected]>
2023-01-16 11:11:35 +01:00
Guillaume Lours 5081ab0507 create custom CLI when dry-run mode active
update documentation

Signed-off-by: Guillaume Lours <[email protected]>
2023-01-16 11:11:35 +01:00
Guillaume Lours fbf845c5f8 add dry-run flag
Signed-off-by: Guillaume Lours <[email protected]>
2023-01-16 11:11:35 +01:00
Nicolas De Loof 8c07fa4d25 mark alpha command as experimental
Signed-off-by: Nicolas De Loof <[email protected]>
2023-01-12 14:44:18 +01:00
Nicolas De Loof bb9cf32245 introduce experimental watch command (skeletton)
Signed-off-by: Nicolas De Loof <[email protected]>
2023-01-12 10:52:58 +01:00
Matt Armand dadad01e63 Update docs programatically like you're supposed to
Signed-off-by: Matt Armand <[email protected]>
2023-01-11 13:20:30 -05:00
Matt Armand 1adc9f54d5 fix docs yaml
Signed-off-by: Matt Armand <[email protected]>
2023-01-11 12:24:15 -05:00
Matt Armand bd8e57447a Add remove-orphans functionality to run, because it recommends that in error messages
Signed-off-by: Matt Armand <[email protected]>
2023-01-11 10:31:56 -05:00
Nicolas De Loof cc912c625d introduce --remove-orphans in compose create command
Signed-off-by: Nicolas De Loof <[email protected]>
2023-01-11 07:16:50 +01:00
Nicolas De Loof d5e4f00644 introduce --no-attach to ignore some service output
Signed-off-by: Nicolas De Loof <[email protected]>
2023-01-03 18:43:40 +01:00
Nicolas De Loof 8b4ac37f9c introduce --ignore-buildable to ignore buildable images on pull
Signed-off-by: Nicolas De Loof <[email protected]>
2023-01-03 18:43:23 +01:00
Laura Brehm 8a3248d0cd Update documentation
Signed-off-by: Laura Brehm <[email protected]>
2022-12-29 13:32:16 +00:00
Nicolas De Loof 84ea395d5d introduce --timestamp option on compose up
Signed-off-by: Nicolas De Loof <[email protected]>
2022-12-15 12:14:22 +01:00
Gabriel Féron e4850d9c48 Add --include-deps to push command
Signed-off-by: Gabriel Féron <[email protected]>
2022-12-15 11:42:14 +01:00
Nicolas De Loof 8c39b5b7fd align --format flag and UX with docker cli
Signed-off-by: Nicolas De Loof <[email protected]>
2022-12-14 22:53:43 +01:00
Nicolas De Loof a0acc20d88 introduce --parallel to limit concurrent engine calls
Signed-off-by: Nicolas De Loof <[email protected]>
2022-12-06 08:15:50 +01:00
Umar Faruq ChowdhuryandMilas Bowman 06e71371ff docs: fix grammatical issues (#9997)
Signed-off-by: Umar Chowdhury <[email protected]>
Co-authored-by: Milas Bowman <[email protected]>
2022-11-29 10:52:22 -05:00
Laura Brehm 88c3aaf1bf Merge pull request #10007 from laurazard/add-build-run
Add `--build` to `compose run`
2022-11-17 20:00:57 +01:00
Laura Brehm 6fe03e935e Update docs
Signed-off-by: Laura Brehm <[email protected]>
2022-11-17 12:29:19 +01:00
Guillaume Lours 32f29b833f add --no-consistency flag to convert command
Signed-off-by: Guillaume Lours <[email protected]>
2022-11-15 10:31:59 +01:00
Nick Sieger 8bd487ac43 docs: update with result of make docs
Signed-off-by: Nick Sieger <[email protected]>
2022-10-11 15:19:24 -05:00
Laura Brehm a226fe9daf Update docs for new compose kill --remove-orphans option
Signed-off-by: Laura Brehm <[email protected]>
2022-08-19 04:29:51 +02:00
Khoa Le 8d4846f210 docs: remove extra whitespaces in help text (#9710)
Remove superfluous whitespaces

Signed-off-by: Khoa Le <[email protected]>
2022-08-03 16:37:15 -04:00
Sebastiaan van Stijn 9db79856be update usage strings for consistency
This updates the format of various usage strings to be more consistent
with other parts of the CLI.

- Use `[OPTIONS]` to indicate where command-specific options should be added
- Use `[SERVICE...]` to indicate zero-or-more services
- Remove some usage strings for specific options (e.g. `-e NAME=VAL`), as that
  option is part of the already mentioned `[OPTIONS]` and we don't provide usage
  for each possible option that can be passed.
- Remove `[--]`, which (I think) was needed for the Python implementation, but is
  a general feature to stop processing flag-options.

Signed-off-by: Sebastiaan van Stijn <[email protected]>
2022-08-02 13:32:29 +02:00
Pierre Roux 38a18790ed cmd: consistent handling no-args commands (#9660)
Enforce args rejection for commands without args:
* ls
* version

Additionally, docs for `restart` are fixed.

Signed-off-by: piroux <[email protected]>
2022-07-29 09:30:11 -04:00
Guillaume Lours e83d940a3c add pull & build config to project before create
add pull flag to create and up documentation

Signed-off-by: Guillaume Lours <[email protected]>
2022-07-27 11:25:53 +02:00
Guillaume Lours 0e6adb2884 update cli-doc-tool and update the doc with this new version
Signed-off-by: Guillaume Lours <[email protected]>
2022-07-26 14:58:08 +02:00
Emmanuel Nuiro f06ab29a84 Fix typo in docker_compose_pull
Signed-off-by: Emmanuel Nuiro <[email protected]>
2022-07-04 22:29:06 +02:00
Emmanuel Nuiro 7f5c166ec9 Fix typo in compose pull documentation
There was an invalid character between the two backticks at the end of the last snippet, causing the styling to break on the online documentation.

Signed-off-by: Emmanuel Nuiro <[email protected]>
2022-07-04 21:45:53 +02:00
Guillaume Lours 6d9d75406c update usage of the index flag of the cp command
Signed-off-by: Guillaume Lours <[email protected]>
2022-05-10 10:50:40 +02:00
Guillaume Lours a983cf551d cp command: copy to all containers of a service as default behaviour
Signed-off-by: Guillaume Lours <[email protected]>
2022-05-10 10:50:40 +02:00
Daniel Lublin d89c143c39 Clarify what default work dir is when multiple compose files
Signed-off-by: Daniel Lublin <[email protected]>
2022-05-03 13:14:34 +02:00
Eric Freese d871cb98e5 Fix search/replace typo in --no-TTY documentation
Commit abbba74b27 looks to have
accidentally replaced `pseudo-tty` with `pseudo-noTty` in several
places. In other places, it looks like it replaced `pseudo-tty` with
`pseudo-TTY`, so I used the uppercased version in these places as well.

For example, running version 2.3.3, I get this output:

```
% docker-compose run --help

...

Options:
  ...
  -T, --no-TTY                Disable pseudo-noTty allocation. By default docker compose run allocates a TTY
  ...
```

Signed-off-by: Eric Freese <[email protected]>
2022-04-04 19:06:03 +02:00
Matthias Schoettle 6dbd6ffe11 fix typo in ssh option description
Signed-off-by: Matthias Schoettle <[email protected]>
2022-03-31 10:14:13 -04:00
Guillaume Lours ff73827a6f Add support of ssh authentications defined in compose file or via cli flags
Signed-off-by: Guillaume Lours <[email protected]>
2022-03-31 12:47:15 +02:00
Guillaume Lours 099715fb6f update run no-TTY flag description as auto-detected by default
Signed-off-by: Guillaume Lours <[email protected]>
2022-03-18 10:42:05 +01:00
Guillaume Lours 35ba6f68e5 generate reference api
Signed-off-by: Guillaume Lours <[email protected]>
2022-03-18 10:42:05 +01:00
Sebastiaan van Stijn 2d32d7450c ps: un-deprecate --filter, and enhance docs
Compose currently only supports a single filter options on --filter,
for which reason the --status flag was added, which is more convenient
to use.

However, the `--filter` flag is common among various docker commands, and
it's possible that additional filters get added at some point (which may
be less "commonly" used, and not warrant a dedicated flag).

This PR removes the "deprecated" mention from the flag, to keep consistency
with other commands, but adds documentation to explain how they relate to
eachother.

Also added a short example for the `--format` flag.

Signed-off-by: Sebastiaan van Stijn <[email protected]>
2022-03-10 20:39:19 +01:00
Sebastiaan van Stijn 42710b7c43 docs: also generate "usage" in MarkDown files
Signed-off-by: Sebastiaan van Stijn <[email protected]>
2022-03-09 14:40:35 +01:00