docs(cli): Added usage docs

[rajdip-b]

PR Type

Documentation

---

Description

• Added comprehensive documentation for the CLI tool, including commands like init, profile, and run.
• Updated the table of contents to include new CLI sections and moved the architecture section under Internals.
• Fixed image paths in the architecture documentation.
• Added a new environment variable NEXT_PUBLIC_BACKEND_URL to the environment variables documentation.
• Provided detailed explanations of the internal workings of the CLI, including configuration files.

---

Changes walkthrough 📝

Relevant files

Documentation

SUMMARY.md Updated table of contents with CLI and Internals sections. docs/SUMMARY.md Added new sections for CLI documentation. Moved the architecture section under Internals. +12/-1    init.md Added documentation for the `init` CLI command.                    docs/cli/init.md Added documentation for the init command. Included usage, options, and descriptions. +37/-0    introduction.md Added introduction to CLI tool and commands.                          docs/cli/introduction.md Introduced the CLI tool and its purpose. Listed available commands and global flags. +31/-0    profile.md Added documentation for the `profile` CLI command.              docs/cli/profile.md Added documentation for the profile command. Included subcommands, usage, and options. +127/-0  run.md Added documentation for the `run` CLI command.                      docs/cli/run.md Added documentation for the run command. Included usage and arguments. +25/-0    environment-variables.md Updated environment variables documentation.                          docs/contributing-to-keyshade/environment-variables.md Added NEXT_PUBLIC_BACKEND_URL environment variable. +3/-1      architecture-of-keyshade.md Fixed image paths in architecture documentation.                  docs/internals/architecture-of-keyshade.md Fixed image paths for architecture diagrams. +5/-5      how-the-cli-works.md Added documentation on how the CLI works.                                docs/internals/how-the-cli-works.md Added documentation on the internal workings of the CLI. Explained configuration files and their purposes. +59/-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]

PR Reviewer Guide 🔍

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

🧪 No relevant tests

🔒 No security concerns identified

⚡ No key issues to review

[codiumai-pr-agent-free]

PR Code Suggestions ✨

Category	Suggestion	Score
Enhancement	Rephrase the introduction for better clarity and readability To improve clarity and readability, consider rephrasing the sentence to avoid repetition and ensure it flows better. docs/cli/introduction.md [7] -Our CLI is one of the major component of keyshade. The CLI is the entrypoint for your application to tap into the live updates from our platform. Whatever changes you make to your secrets or variables in your project, are reflected automatically in your application. Besides that, it also helps you to interact with the keyshade API. +Our CLI is a major component of keyshade, serving as the entry point for your application to receive live updates from our platform. Any changes you make to your project's secrets or variables are automatically reflected in your application. Additionally, the CLI facilitates interaction with the keyshade API. Apply this suggestion Suggestion importance[1-10]: 7 Why: The suggested rephrasing improves clarity and readability by reducing repetition and enhancing the flow of the sentence.	7
	Rephrase the sentence to avoid redundancy and improve readability To avoid redundancy and improve readability, consider rephrasing the sentence to eliminate the repeated phrase "we wanted to ensure." docs/internals/how-the-cli-works.md [11] -We wanted to ensure that the CLI is fast and efficient, so that you can get your work done quickly. +We aimed to make the CLI fast and efficient, enabling you to complete your tasks quickly. Apply this suggestion Suggestion importance[1-10]: 6 Why: The suggested rephrasing eliminates redundancy and makes the sentence more concise, which improves readability.	6
	Clarify the usage of the argument in the run command documentation To enhance clarity, specify that the argument should be the command to run the user's application. docs/cli/run.md [19-21] ### `<command>` -The command to run your application. This command is run in the same shell as the `keyshade run` command. +The command to run your application. Replace `<command>` with the specific command you want to execute. This command is run in the same shell as the `keyshade run` command. Apply this suggestion Suggestion importance[1-10]: 5 Why: The suggestion adds a minor clarification to the <command> argument, which slightly improves the documentation but does not significantly impact understanding.	5
Best practice	Adjust heading levels for subcommands to improve readability and consistency For better readability and consistency, consider changing the heading levels of subcommands under the profile command to be consistent with other sections. docs/cli/profile.md [21-35] -## `create` +### `create` -### Usage +#### Usage ```bash keyshade profile create [options] -### Options +#### Options These are the commands supported by the create command: -#### -n, --name <name> +##### -n, --name <name> The name of the profile. This is a required field. - [ ] **Apply this suggestion** <!-- /improve --apply_suggestion=3 --> <details><summary>Suggestion importance[1-10]: 6</summary> Why: Adjusting the heading levels improves consistency across the document, which enhances readability and document structure. </details></details></td><td align=center>6 </td></tr></tr></tbody></table>