Skip to content
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.

Sign up for GitHub

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: Updated CLI docs #460

Merged
merged 1 commit into from
Sep 21, 2024
Merged

docs: Updated CLI docs #460

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions docs/contributing-to-keyshade/design-of-our-code/cli.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
11 changes: 10 additions & 1 deletion docs/contributing-to-keyshade/running-things-locally/running-the-cli.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -19,4 +26,6 @@ You can get started with developing the CLI using the following steps:

```bash
pnpm dev:cli -- <whatever command goes here>
```
```

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.