-
-
Notifications
You must be signed in to change notification settings - Fork 115
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
docs(cli): Added docs for the CLI package #329
Conversation
PR Reviewer Guide 🔍
|
PR Code Suggestions ✨
|
## [2.2.0](v2.1.0...v2.2.0) (2024-07-11) ### 🚀 Features * **api-client:** Added API Client package ([#346](#346)) ([6734e1e](6734e1e)) * **api:** Updated API key ([fbac312](fbac312)) * **platform:** View [secure]s ([#313](#313)) ([97c4541](97c4541)) * **web:** Add Pricing Page ([#243](#243)) ([2c7f1d6](2c7f1d6)) ### 📚 Documentation * **cli:** Added docs for the CLI package ([#329](#329)) ([edad166](edad166)) * **cli:** Added usage docs ([#330](#330)) ([b6963d5](b6963d5)) * Update Discord link ([871b6cd](871b6cd)) * Update README.md ([e66fcd2](e66fcd2)) * **web:** Add documentation about our web package ([#268](#268)) ([3d848e7](3d848e7)) ### 🔧 Miscellaneous Chores * **api:** Updated response types in environment service ([b8a3ddd](b8a3ddd)) * **ci:** Added release scripts for platform and api ([02dae60](02dae60)) * **CI:** Updated action plugin versions ([88bb317](88bb317)) * **CI:** Updated pnpm version in CI file ([2692e88](2692e88)) * **platform:** Fixed env parsing in platform ([d6ffafa](d6ffafa)) * **web:** Update Terms and Conditions and Privacy Policy ([#282](#282)) ([d621dcb](d621dcb)) ### 🔨 Code Refactoring * **api:** Update [secure] and variable fetching endpoints ([7d9acd0](7d9acd0)) * **cli:** Refactored profile commands into readable blocks ([#331](#331)) ([4a8a089](4a8a089)) * **cli:** Updated configuration commands and mechanism ([#310](#310)) ([9079b6d](9079b6d))
## [2.2.0](v2.1.0...v2.2.0) (2024-07-11) ### 🚀 Features * **api-client:** Added API Client package ([#346](#346)) ([6734e1e](6734e1e)) * **api:** Updated API key ([fbac312](fbac312)) * **platform:** View [secure]s ([#313](#313)) ([97c4541](97c4541)) * **web:** Add Pricing Page ([#243](#243)) ([2c7f1d6](2c7f1d6)) ### 📚 Documentation * **cli:** Added docs for the CLI package ([#329](#329)) ([edad166](edad166)) * **cli:** Added usage docs ([#330](#330)) ([b6963d5](b6963d5)) * Update Discord link ([871b6cd](871b6cd)) * Update README.md ([e66fcd2](e66fcd2)) * **web:** Add documentation about our web package ([#268](#268)) ([3d848e7](3d848e7)) ### 🔧 Miscellaneous Chores * **api:** Updated response types in environment service ([b8a3ddd](b8a3ddd)) * **ci:** Added release scripts for platform and api ([02dae60](02dae60)) * **CI:** Updated action plugin versions ([88bb317](88bb317)) * **CI:** Updated pnpm version in CI file ([2692e88](2692e88)) * **platform:** Fixed env parsing in platform ([d6ffafa](d6ffafa)) * **web:** Update Terms and Conditions and Privacy Policy ([#282](#282)) ([d621dcb](d621dcb)) ### 🔨 Code Refactoring * **api:** Update [secure] and variable fetching endpoints ([7d9acd0](7d9acd0)) * **cli:** Refactored profile commands into readable blocks ([#331](#331)) ([4a8a089](4a8a089)) * **cli:** Updated configuration commands and mechanism ([#310](#310)) ([9079b6d](9079b6d))
PR Type
Documentation, Enhancement
Description
--overwrite
option in the InitCommand.SUMMARY.md
to include links to new CLI documentation sections and reordered some sections for better organization.Changes walkthrough 📝
init.command.ts
Add default value for `--overwrite` option in InitCommand
apps/cli/src/commands/init.command.ts
--overwrite
option in the CLI command.SUMMARY.md
Update SUMMARY.md to include CLI documentation
docs/SUMMARY.md
README.md
Add CLI link to design documentation README
docs/contributing-to-keyshade/design-of-our-code/README.md
cli.md
Add detailed design documentation for CLI
docs/contributing-to-keyshade/design-of-our-code/cli.md
practices.
web.md
Enhance web design documentation with descriptions and formatting
docs/contributing-to-keyshade/design-of-our-code/web.md
README.md
Update local running instructions to include CLI and Web
docs/contributing-to-keyshade/running-things-locally/README.md
running-the-cli.md
Add instructions for running the CLI locally
docs/contributing-to-keyshade/running-things-locally/running-the-cli.md