keyshade-xyz/cli

Manage projects using CLI

Opened this issue · 0 comments

Description

Create and manage projects using CLI. Here are the aspects to manage:

Creating a project

Command

ks project create <workspace_id> <options>

Options

  • --name/-n: Name of the workspace
  • --description/-d: (Optional) Description of the workspace
  • --storePrivateKey: (Optional) Whether to store the private key in the project or not. Defaults to false.
  • --isPublic: (Optional) Whether the project would be accessible by everyone or not. Defaults to false.

Updating a project

Command

ks project update <project_id> <options>

Options

Specifying any of these options will update only that specific property of the project. At least one option needs to be specified for this command to run.

  • --name/-n: (Optional) Name of the workspace
  • --description/-d: (Optional) Description of the workspace
  • --storePrivateKey: (Optional) Whether to store the private key in the project or not. Defaults to false.
  • --isPublic: (Optional) Whether the project would be accessible by everyone or not. Defaults to false.

Listing all projects

Command

ks project list <workspace_id> <options>

Options

  • --page: (Optional) The page index
  • --size: (Optional) Size of the page

Deleting a project

Command

ks project delete <project_id>

Read a project

Command

ks project read <project_id>