osl-incubator / sugar

Simplify the usage of containers
https://osl-incubator.github.io/sugar/
BSD 3-Clause "New" or "Revised" License
6 stars 8 forks source link

feat(help): Create a group for plugins in the help menu #123

Closed xmnlab closed 1 month ago

xmnlab commented 1 month ago

Pull Request description

How to test these changes

Pull Request checklists

This PR is a:

About this PR:

Author's checklist:

Additional information

Reviewer's checklist

Copy and paste this template for your review's note:

## Reviewer's Checklist

- [ ] I managed to reproduce the problem locally from the `main` branch
- [ ] I managed to test the new changes locally
- [ ] I confirm that the issues mentioned were fixed/resolved .
xmnlab commented 1 month ago

example:

$ sugar --help

 Usage: sugar [OPTIONS] COMMAND [ARGS]...                                                   

 Sugar is a tool that help you to organizeand simplify your containers' stack.              

╭─ Options ────────────────────────────────────────────────────────────────────────────────╮
│ --version             -v        Show the version of sugar.                               │
│ --verbose                       Show the command executed.                               │
│ --install-completion            Install completion for the current shell.                │
│ --show-completion               Show completion for the current shell, to copy it or     │
│                                 customize the installation.                              │
│ --help                          Show this message and exit.                              │
╰──────────────────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ───────────────────────────────────────────────────────────────────────────────╮
│ attach    Attach to a service's running container.                                       │
│ build     Build or rebuild services.                                                     │
│ config    Parse, resolve and render compose file in canonical format.                    │
│ cp        Copy files/folders between a services and local filesystem.                    │
│ create    Create containers for a service.                                               │
│ down      Stop and remove containers, networks.                                          │
│ events    Receive real time events from containers.                                      │
│ exec      Execute a command in a running container.                                      │
│ images    List images used by the created containers.                                    │
│ kill      Force stop service containers.                                                 │
│ logs      View output from containers.                                                   │
│ ls        List running compose projects.                                                 │
│ pause     Pause services.                                                                │
│ port      Print the public port for a port binding.                                      │
│ ps        List containers.                                                               │
│ pull      Pull service images.                                                           │
│ push      Push service images.                                                           │
│ restart   Restart service containers.                                                    │
│ rm        Remove stopped service containers.                                             │
│ run       Run a one-off command on a service.                                            │
│ scale     Scale services.                                                                │
│ start     Start services.                                                                │
│ stop      Stop services.                                                                 │
│ top       Display the running processes.                                                 │
│ unpause   Unpause services.                                                              │
│ up        Create and start containers.                                                   │
│ version   Show the Docker Compose version information.                                   │
│ wait      Block until the first service container stops.                                 │
│ watch     Watch build context.                                                           │
╰──────────────────────────────────────────────────────────────────────────────────────────╯
╭─ Plugins ────────────────────────────────────────────────────────────────────────────────╮
│ ext       Use the `ext` plugin.                                                          │
│ stats     Use the `stats` plugin.                                                        │
╰──────────────────────────────────────────────────────────────────────────────────────────╯

 If you have any problem, open an issue at: https://github.com/osl-incubator/sugar          
github-actions[bot] commented 1 month ago

:tada: This issue has been resolved in version 1.14.0 :tada:

The release is available on:

Your semantic-release bot :package::rocket: