-
Notifications
You must be signed in to change notification settings - Fork 5
Feature cli command reference 63 #155
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
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
As was discussed this sprint, https://polykey.com/docs/reference/polykey-cli/commands/ already exists in Polykey docs for referencing the commands and all the commands that exist. The function for some would be obvious, some would be a bit harder to understand. To start off, fill in all the commands you know or were able to figure out, and flag the ones you haven't touched yet.
Then, for each command you are going over, read the relevant section in the documentation and test the different commands/usages yourself using your own polykey agent to confirm if they are still accurate or not. This is important, as we don't want outdated or wrong information, and ChatGPT has a tendency to generate both valid and invalid commands. You need to be careful.
Some commands might have not changed much, like maybe polykey vaults ls
. Confirm by running the commands locally that it matches the expectation, then continue if there's nothing to change.
Run polykey locally using polykey ... --help
, where you put the relevant command or subcommand in the ...
. The --help
flag will tell you the description of the command, and subcommands or arguments if applicable. You can use that to get a preview of the commands and their structure. Make sure the structure on the docs reflect the actual structure locally.
This PR is being closed because the CLI command reference docs already exist and this file is redundant. |
Well you still need to go over it and make sure all the commands are up to date. You need to do things like removing old commands, adding new ones, and updating existing ones if they changed at all. |
Description
This PR introduces a new CLI command reference index page (
list-of-commands.md
) under thepolykey-cli
documentation section. It provides a categorized overview of all availablepolykey
commands, linking to their respective detailed documentation (to be created or expanded in follow-up PRs).Issues Fixed
Tasks
list-of-commands.md
file indocs/Getting-Started/polykey-cli/
Final checklist