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

CLI help (commands, arguments, ...) missing #132

Open
gramian opened this issue Dec 12, 2024 · 2 comments
Open

CLI help (commands, arguments, ...) missing #132

gramian opened this issue Dec 12, 2024 · 2 comments

Comments

@gramian
Copy link

gramian commented Dec 12, 2024

Issue description

I am missing a listing of available commands, arguments and options for the CLI app. Basically I mean the info that is on the help screen of the CLI.

Updates to existing documentation

I guess this would be a new page? Maybe under Configuration?

Link to Redpanda Slack conversation

https://discord.com/channels/746368194196799589/754099840354615296/1316786815872532532

@rockwotj
Copy link
Collaborator

There is some here: https://docs.redpanda.com/current/reference/rpk/rpk-connect/rpk-connect/

But you're right it should be on the connect page too

@gramian
Copy link
Author

gramian commented Jan 22, 2025

I was thinking of the CLI help of what used to be or is Benthos, ie:

NAME:
   benthos - A stream processor for mundane tasks - https://benthos.dev/docs

USAGE:
   benthos [global options] command [command options]

DESCRIPTION:
   Either run Benthos as a stream processor or choose a command:

     benthos list inputs
     benthos create kafka//file > ./config.yaml
     benthos run ./config.yaml
     benthos run -r "./production/*.yaml" ./config.yaml

COMMANDS:
   echo      Parse a config file and echo back a normalised version
   lint      Parse Benthos configs and report any linting errors
   run       Run Benthos in normal mode against a specified config file
   streams   Run Benthos in streams mode
   list      List all Benthos component types
   create    Create a new Benthos config
   test      Execute Benthos unit tests
   template  Interact and generate Benthos templates
   blobl     Execute a Benthos mapping on documents consumed via stdin
   help, h   Shows a list of commands or help for one command

GLOBAL OPTIONS:
   --version, -v  display version info, then exit (default: false)
   --help, -h     show help

A use case would be starting a local blobl server, like ./benthos blobl server this or the rpk equivalent is not documented it seems, or did I overlook something in the docs?

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

No branches or pull requests

2 participants