docs: Add documentation for environment in CLI

[Allan2000-Git]

User description

Description

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

Fixes #457

Dependencies

No new dependencies introduced.

Future Improvements

Consider adding examples for common use cases of the scan 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 a new documentation file for the environment command in the Keyshade CLI.
• Documented subcommands including create, delete, get, list, and update.
• Provided detailed usage instructions, arguments, and options for each subcommand.
• Enhanced user understanding of managing environments within Keyshade.

---

Changes walkthrough 📝

	Relevant files
Documentation	environment.md Add comprehensive documentation for `environment` CLI command docs/cli/environment.md Added documentation for the environment command in Keyshade CLI. Detailed subcommands: create, delete, get, list, update. Provided usage examples and options for each subcommand. Included arguments and options descriptions for better understanding. +126/-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

⚡ Key issues to review Inconsistent Formatting The formatting for the 'Options' section under the 'list' command (lines 93-99) is inconsistent with other commands. It mentions 'create' command instead of 'list'. Unclear Information The 'Options' section for the 'update' command (lines 115-125) uses tentative language ("might be supported"), which could confuse users about the actual available options.

[codiumai-pr-agent-free]

PR Code Suggestions ✨

Category	Suggestion	Score
Possible issue	✅ Correct the description of arguments for the list command Suggestion Impact: The suggestion corrected the command name from "update" to "list" in the documentation, which was implemented in the commit. code diff: -These are the arguments supported by the update command: +These are the arguments supported by the list command: Correct the description of arguments for the list command. It currently mentions "update command" which is incorrect. docs/cli/environment.md [85-91] ### Arguments -These are the arguments supported by the update command: +These are the arguments supported by the list command: #### `<project-slug>` -Slug of the project whose environments you want. +Slug of the project whose environments you want to list. Apply this suggestion Suggestion importance[1-10]: 9 Why: The suggestion addresses a clear error in the documentation, where the wrong command is referenced. Correcting this mistake is crucial for clarity and accuracy.	9
Enhancement	Provide more detailed information about pagination options Clarify the description of the PAGINATION_OPTION for the list command. Provide more details or a link to where these options are defined. docs/cli/environment.md [97-99] -#### `PAGINATION_OPTION` +#### Pagination Options -The `list` command supports pagination options. These options are defined in the `PAGINATION_OPTION` constant. +The `list` command supports pagination options. These options include: +- `--page <number>`: The page number to retrieve (default: 1) +- `--per-page <number>`: Number of items per page (default: 20) + +For more details on pagination, refer to the [Pagination section](link-to-pagination-docs). + Apply this suggestion Suggestion importance[1-10]: 8 Why: Clarifying the pagination options with specific details and a reference link improves the documentation's usefulness and helps users understand how to effectively use pagination.	8
	Improve the clarity of the update command options description Update the description of options for the update command to be more definitive, removing the uncertainty implied by "might be supported". docs/cli/environment.md [115-125] ### Options -These are the options that might be supported by the `update` command: +These are the options supported by the `update` command: #### `-n, --name <string>` The new name for the environment. #### `-d, --description <string>` The new description for the environment. Apply this suggestion Suggestion importance[1-10]: 8 Why: Removing uncertainty in the options description for the update command enhances clarity, ensuring users have a definitive understanding of the available options.	8
	Add usage examples for each subcommand to improve user understanding Consider adding a brief example for each subcommand to demonstrate its usage. This will help users understand how to use the commands in practice. docs/cli/environment.md [21-47] ## `create` ### Usage ```bash keyshade environment create <project-slug> [options] Arguments -These are the arguments supported by the update command: +These are the arguments supported by the create command: <project-slug> The slug of the project under which you want to add the environment. Options These are the options supported by the create command: -n, --name <string> The name of the environment. -d, --description <string> A description of the environment. +### Example + +bash +keyshade environment create my-project -n "Production" -d "Production environment for my-project" + + - [ ] **Apply this suggestion** <!-- /improve --apply_suggestion=3 --> <details><summary>Suggestion importance[1-10]: 7</summary> Why: Adding examples for each subcommand enhances the documentation by providing practical usage scenarios, which can significantly aid user comprehension and application of the commands. </details></details></td><td align=center>7 </td></tr></tr></tbody></table> >💡 Need additional feedback ? start a [PR chat](https://chromewebstore.google.com/detail/ephlnjeghhogofkifjloamocljapahnl)

[rajdip-b]

Needs a few changes, I'll mark them late tonight.

[Allan2000-Git]

@rajdip-b I have made the changes.

[rajdip-b]

🎉 This PR is included in version 2.6.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀