Skip to content
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.

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

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

Merged
merged 2 commits into from
Jul 24, 2024

Conversation

xmnlab
Copy link
Member

@xmnlab xmnlab commented Jul 24, 2024

Pull Request description

How to test these changes

  • ...

Pull Request checklists

This PR is a:

  • bug-fix
  • new feature
  • maintenance

About this PR:

  • it includes tests.
  • the tests are executed on CI.
  • the tests generate log file(s) (path).
  • pre-commit hooks were executed locally.
  • this PR requires a project documentation update.

Author's checklist:

  • I have reviewed the changes and it contains no misspelling.
  • The code is well commented, especially in the parts that contain more complexity.
  • New and old tests passed locally.

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
Copy link
Member Author

xmnlab commented Jul 24, 2024

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          
 

@xmnlab xmnlab merged commit b8980cc into osl-incubator:main Jul 24, 2024
9 checks passed
@xmnlab xmnlab deleted the improve-help-menu-plugin branch July 24, 2024 03:46
Copy link

🎉 This issue has been resolved in version 1.14.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant