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.

Sign up for GitHub

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

Jump to bottom

cli: add 'help' symbol to klish, print help text for command. #455

Closed
troglobit opened this issue May 16, 2024 · 1 comment · Fixed by #491
Closed

cli: add 'help' symbol to klish, print help text for command. #455

troglobit opened this issue May 16, 2024 · 1 comment · Fixed by #491
Assignees
@troglobit
Labels
enhancement New feature or request feature Feature request
Milestone
Infix v24.06

Comments

@troglobit
Copy link
Contributor

troglobit commented May 16, 2024 •
edited
Loading

In klish-plugin-infix we should have a help callback for admin-exec to handle printing help text for a single command, similar to help in configure context.
@troglobit troglobit added enhancement New feature or request feature Feature request labels May 16, 2024
@troglobit
Copy link
Contributor Author

Alternatively, we could write a doc/cli/<command>.md, i.e., a markdown file for each top-level command. This would also help the overall documentation of the project.

Ideally, the cli/doc/tutorial.md could be split up or act as an overview of the other topics/commands. E.g., the "Upgrading the Software" section could become doc/cli/upgrade.md.

@troglobit troglobit self-assigned this Jun 28, 2024
@troglobit troglobit added this to the Infix v24.06 milestone Jun 28, 2024
troglobit added a commit that referenced this issue Jun 28, 2024
@troglobit
doc: split CLI tutorial into multile files
742041f 
Fixes #455

Signed-off-by: Joachim Wiberg <troglobit@gmail.com>
@troglobit troglobit linked a pull request Jun 28, 2024 that will close this issue
Documentation updates #491
Merged
13 tasks
troglobit added a commit that referenced this issue Jun 28, 2024
@troglobit
doc: split CLI tutorial into multile files
867d279 
Fixes #455

Signed-off-by: Joachim Wiberg <troglobit@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@troglobit troglobit

Labels
enhancement New feature or request feature Feature request
Projects
Infix & C:o
Status: Done
Milestone
Infix v24.06
Development

Successfully merging a pull request may close this issue.

Documentation updates kernelkit/infix
1 participant
@troglobit