docs: Adding documentation for cli command

[YuvalBubnovsky]

User description

Description

This PR adds documentation for the workspace feature in the CLI, providing users with clear instructions on how to utilize this functionality effectively.

Fixes #458

Dependencies

No new dependencies introduced.

Future Improvements

Possibly adding examples for common use cases of the workspace feature in future documentation updates.

Mentions

@rajdip-b

Screenshots of relevant screens

N/A

Developer's checklist

• My PR follows the style guidelines of this project
• I have performed a self-check on my work

If changes are made in the code:

• I have followed the coding guidelines
• My changes in code generate no new warnings
• My changes are breaking another fix/feature of the project
• I have added test cases to show that my feature works
• I have added relevant screenshots in my PR
• There are no UI/UX issues

Documentation Update

• This PR requires an update to the documentation at docs.keyshade.xyz
• I have made the necessary updates to the documentation, or no documentation changes are required.

---

PR Type

Documentation

---

Description

• Added detailed documentation for the workspace command in the CLI, including descriptions and usage examples for subcommands such as create, delete, export, get, list, search, and update.
• Provided comprehensive details on command arguments and options to guide users in managing workspaces effectively.

---

Changes walkthrough 📝

	Relevant files
Documentation	workspace.md Add documentation for `workspace` CLI command and subcommands docs/cli/workspace.md Added comprehensive documentation for the workspace CLI command. Detailed subcommands: create, delete, export, get, list, search, update. Included usage examples and options for each subcommand. Provided descriptions for command arguments and options. +180/-0

---

💡 PR-Agent usage: Comment /help "your question" on any pull request to receive relevant information

[codiumai-pr-agent-free]

PR Reviewer Guide 🔍

⏱️ Estimated effort to review: 2 🔵🔵⚪⚪⚪

🧪 No relevant tests

🔒 No security concerns identified

⚡ No key issues to review

[codiumai-pr-agent-free]

PR Code Suggestions ✨

Category	Suggestion	Score
Best practice	Add a note about confirmation and potential data loss for the delete command Add information about any confirmation prompts or safety measures for the delete command, as deleting a workspace is a significant action that could lead to data loss. docs/cli/workspace.md [44-58] ## `delete` ### Usage ```bash keyshade workspace delete <workspace slug> Arguments These are the arguments supported by the delete command: <workspace slug> Slug of the workspace which you want to delete. +### Note + +This command will prompt for confirmation before deleting the workspace. Use with caution as this action cannot be undone and will result in the loss of all associated data. + - [ ] **Apply this suggestion** <!-- /improve --apply_suggestion=0 --> <details><summary>Suggestion importance[1-10]: 9</summary> Why: This suggestion addresses a critical aspect of user interaction by highlighting the importance of confirmation prompts for potentially destructive actions, thereby preventing accidental data loss. </details></details></td><td align=center>9 </td></tr><tr><td rowspan=3><strong>Enhancement</strong></td> <td> <details><summary>Add information about the export format and security considerations</summary> ___ **For the <code>export</code> command, consider adding information about the format of the exported <br>data (e.g., JSON, YAML) and any security considerations for handling the exported <br>file.** [docs/cli/workspace.md [60-82]](https://github.com/keyshade-xyz/keyshade/pull/464/files#diff-b05e29e0937dd69ff54edad8518a573758815266e1c67c038074d2fa4481dc2dR60-R82) ```diff ## `export` ### Usage ```bash keyshade workspace export <workspace slug> [options] Arguments These are the arguments supported by the export command: <workspace slug> Slug of the workspace which you want to export. Options These are the options supported by the export command: -s, --save-to-file <file> Saves the exported data to a file. If not provided, the data will be printed to the console. +### Note + +The exported data is in JSON format. Please handle the exported file with care, as it may contain sensitive information. Consider encrypting the file or storing it in a secure location. + - [ ] **Apply this suggestion** <!-- /improve --apply_suggestion=1 --> <details><summary>Suggestion importance[1-10]: 8</summary> Why: Providing details about the export format and security considerations is important for users to handle sensitive data appropriately, enhancing both usability and security. </details></details></td><td align=center>8 </td></tr><tr><td> <details><summary>Add more details about the expected input for the icon option</summary> ___ **Consider adding a brief description or example for the <code>icon</code> option in the <code>create</code> and <br><code>update</code> commands. This could help users understand what type of input is expected <br>(e.g., a URL, a file path, or a predefined icon name).** [docs/cli/workspace.md [41-42]](https://github.com/keyshade-xyz/keyshade/pull/464/files#diff-b05e29e0937dd69ff54edad8518a573758815266e1c67c038074d2fa4481dc2dR41-R42) ```diff #### `-i, --icon <icon>` -The icon to be used for this workspace (optional). +The icon to be used for this workspace (optional). This could be a URL to an image, a file path, or a predefined icon name (e.g., "rocket", "star", "folder"). Apply this suggestion Suggestion importance[1-10]: 7 Why: The suggestion enhances user understanding by specifying the types of inputs expected for the icon option, which improves usability and reduces potential confusion.	7
Add usage examples for the list command options For the list command, consider adding examples of how to use the various options together, as this can help users understand how to effectively filter and sort the workspace list. docs/cli/workspace.md [100-130] ## `list` ### Usage ```bash keyshade workspace list [options] Options These are the options supported by the list command: -p, --page <int> Index of the page. -l, --limit <int> Total number of items per page. -o, --order <string> Order to sort by - either ascending (ASC) or descending (DESC). --sort, --sort <string> Field to sort by. -s, --search <string> Search term. +### Examples + +List the first 10 workspaces: +bash +keyshade workspace list -l 10 + + +List workspaces, sorted by name in descending order: +bash +keyshade workspace list --sort name -o DESC + + +Search for workspaces containing "project" in their name: +bash +keyshade workspace list -s project + + - [ ] **Apply this suggestion** <!-- /improve --apply_suggestion=3 --> <details><summary>Suggestion importance[1-10]: 6</summary> Why: Including examples for using command options can significantly aid users in understanding how to effectively utilize the command, though it is not as critical as addressing security or data loss concerns. </details></details></td><td align=center>6 </td></tr></tr></tbody></table> >💡 Need additional feedback ? start a [PR chat](https://chromewebstore.google.com/detail/ephlnjeghhogofkifjloamocljapahnl)

[YuvalBubnovsky]

@rajdip-b I feel like the bot's suggestion for adding the info about the delete command is wrong, from what I've seen in the code (apps/cli/src/commands/workspace/delete.workspace.ts), no such confirmation for deletion exists..

I also think the suggestion for adding usage examples to list is redundent, but if you think this is a good idea - I'll add those.

[rajdip-b]

@rajdip-b I feel like the bot's suggestion for adding the info about the delete command is wrong, from what I've seen in the code (apps/cli/src/commands/workspace/delete.workspace.ts), no such confirmation for deletion exists..

I also think the suggestion for adding usage examples to list is redundent, but if you think this is a good idea - I'll add those.

Hmm, I think you have a valid point in here. Cool, you can drop that suggestion!

[YuvalBubnovsky]

@rajdip-b
added 'into JSON format' and rebased.

[rajdip-b]

🎉 This PR is included in version 2.6.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀