docs(cli): Added docs for the CLI package

[rajdip-b]

PR Type

Documentation, Enhancement

---

Description

• Added a default value for the --overwrite option in the InitCommand.
• Updated SUMMARY.md to include links to new CLI documentation sections and reordered some sections for better organization.
• Added a link to the new CLI documentation in the design documentation README.
• Created a detailed design document for the CLI, including stack, structure, BaseCommand class, and best practices.
• Enhanced web design documentation with descriptions and improved formatting.
• Updated local running instructions to include CLI and Web.
• Added a new document detailing how to run the CLI locally.

---

Changes walkthrough 📝

	Relevant files
Enhancement	init.command.ts Add default value for `--overwrite` option in InitCommand apps/cli/src/commands/init.command.ts Added a default value for the --overwrite option in the CLI command. +2/-1
Documentation	SUMMARY.md Update SUMMARY.md to include CLI documentation                      docs/SUMMARY.md Added links to new CLI documentation sections. Reordered some sections for better organization. +4/-1      README.md Add CLI link to design documentation README                            docs/contributing-to-keyshade/design-of-our-code/README.md - Added a link to the new CLI documentation. +3/-1      cli.md Add detailed design documentation for CLI                                docs/contributing-to-keyshade/design-of-our-code/cli.md Created a new document detailing the design of the CLI. Included sections on stack, structure, BaseCommand class, and best practices. +84/-0    web.md Enhance web design documentation with descriptions and formatting docs/contributing-to-keyshade/design-of-our-code/web.md Added a description front matter. Improved formatting and added missing sections. +9/-1      README.md Update local running instructions to include CLI and Web  docs/contributing-to-keyshade/running-things-locally/README.md - Added links to new CLI and Web running instructions. +2/-0      running-the-cli.md Add instructions for running the CLI locally                          docs/contributing-to-keyshade/running-things-locally/running-the-cli.md - Created a new document detailing how to run the CLI locally. +22/-0

---

💡 PR-Agent usage: Comment /help on the PR to get a list of all available PR-Agent tools and their descriptions

[codiumai-pr-agent-free[bot]]

PR Reviewer Guide 🔍

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

🧪 No relevant tests

🔒 No security concerns identified

⚡ No key issues to review

[codiumai-pr-agent-free[bot]]

PR Code Suggestions ✨

Category	Suggestion	Score
Best practice	Add a step to install dependencies before starting development ___ **Include a step to install dependencies before starting the development process to avoid missing dependencies issues.** [docs/contributing-to-keyshade/running-things-locally/running-the-cli.md [7]](https://github.com/keyshade-xyz/keyshade/pull/329/files#diff-221720c0ac7b87b993eca0a3bb505708e764cc6615a927f013dbc5e5bbcc3546R7-R7) ```diff +- Install dependencies: + ```bash + pnpm install + ``` - Start developing the code ``` - [ ] **Apply this suggestion** Suggestion importance[1-10]: 8 Why: Including a step to install dependencies is crucial to ensure that all necessary packages are available before development begins, preventing potential issues.	8
Maintainability	Add a note to ensure correct import of the COMMANDS variable in index.ts ___ **Add a note to ensure that the COMMANDS variable is imported correctly in index.ts to avoid runtime errors.** [docs/contributing-to-keyshade/design-of-our-code/cli.md [50]](https://github.com/keyshade-xyz/keyshade/pull/329/files#diff-2b28c23a224e91f518e2220348f0eb45513730b32d59c43b910a10a4b232a842R50-R50) ```diff -Once you have finished working on the commands, you would need to add the command to the `COMMANDS` variable in `index.ts`. +Once you have finished working on the commands, you would need to add the command to the `COMMANDS` variable in `index.ts`. Ensure that the `COMMANDS` variable is imported correctly to avoid runtime errors. ``` - [ ] **Apply this suggestion** Suggestion importance[1-10]: 7 Why: Adding a note about the correct import of the `COMMANDS` variable is a good practice to prevent runtime errors and improve maintainability.	7
Enhancement	Add a brief description of the components directory ___ **Add a brief description of the components directory to maintain consistency with other directory descriptions.** [docs/contributing-to-keyshade/design-of-our-code/web.md [46]](https://github.com/keyshade-xyz/keyshade/pull/329/files#diff-761a5f4748db5ef78e95e580e1b63f204e00aabebd3acdb7e4c08da2506272e5R46-R46) ```diff -- **components**: Reusable pieces used in the app. +- **components**: Contains reusable pieces used in the app, such as UI components and widgets. ``` - [ ] **Apply this suggestion** Suggestion importance[1-10]: 6 Why: Enhancing the description of the `components` directory improves documentation clarity and consistency with other directory descriptions.	6