From e49417d95fd9831aa7cad1b877c638ed8166f7e9 Mon Sep 17 00:00:00 2001 From: rajdip-b Date: Sat, 21 Sep 2024 17:27:13 +0530 Subject: [PATCH] Updated CLI docs --- .../design-of-our-code/cli.md | 3 +-- .../running-things-locally/running-the-cli.md | 11 ++++++++++- 2 files changed, 11 insertions(+), 3 deletions(-) diff --git a/docs/contributing-to-keyshade/design-of-our-code/cli.md b/docs/contributing-to-keyshade/design-of-our-code/cli.md index 5e20bf6d..8cd9cc07 100644 --- a/docs/contributing-to-keyshade/design-of-our-code/cli.md +++ b/docs/contributing-to-keyshade/design-of-our-code/cli.md @@ -21,9 +21,8 @@ We are following the principles of OOP to design a clean and extendible CLI. The ### Folder structure - **commands**: Contains the command files that are used by the CLI -- **utils**: Contains utility functions that are used across the CLI +- **util**: Contains utility functions that are used across the CLI - **types**: Contains the types that are used across the CLI -- **http**: Contains the HTTP client that is used to interact with the keyshade API ### The `BaseCommand` class diff --git a/docs/contributing-to-keyshade/running-things-locally/running-the-cli.md b/docs/contributing-to-keyshade/running-things-locally/running-the-cli.md index 7d46d416..1292d914 100644 --- a/docs/contributing-to-keyshade/running-things-locally/running-the-cli.md +++ b/docs/contributing-to-keyshade/running-things-locally/running-the-cli.md @@ -8,6 +8,13 @@ You can get started with developing the CLI using the following steps: - Start developing the code +- The CLI depends upon 2 internal packages: `@keyshade/api-client` and `@keyshade/secret-scan`. Build these two packages: + + ```bash + pnpm build:api-client + pnpm build:secret-scan + ``` + - Run the API: ```bash @@ -19,4 +26,6 @@ You can get started with developing the CLI using the following steps: ```bash pnpm dev:cli -- - ``` \ No newline at end of file + ``` + +Note that, if you make any changes to any of the two packages mentioned above, you would need to rebuild them. Otherwise, the changes would not be reflected in the CLI.