Project
The `project` command
The project
command is used to manage projects within a workspace in Keyshade. It provides various subcommands to perform different operations on projects.
Usage
Subcommands
The project
command includes the following subcommands:
create
: Create a new project.delete
: Delete an existing project.fork
: Fork an existing project.get
: Get details of a specific project.list-forks
: List all forks of a project.list
: List all projects in a workspace.sync
: Synchronize a project with its parent.unlink
: Unlink a project from its parent.update
: Update the properties of an existing project.
create
create
Usage
Arguments
These are the arguments supported by the create command:
<workspace-slug>
<workspace-slug>
The slug of the workspace under which you want to create the project.
Options
These are the options supported by the create
command:
-n, --name <string>
-n, --name <string>
The name of the project.
-d, --description <string>
-d, --description <string>
Description of the project. Defaults to project name.
-k, --store-private-key
-k, --store-private-key
Store the private key in the project. Defaults to true.
-a, --access-level <string>
-a, --access-level <string>
Access level of the project. Defaults to PRIVATE. Choices are GLOBAL, PRIVATE, INTERNAL.
delete
delete
Usage
Arguments
These are the arguments supported by the delete
command:
<project-slug>
<project-slug>
The slug of the project that you want to delete.
fork
fork
Usage
Arguments
These are the arguments supported by the fork command:
<project-slug>
<project-slug>
The slug of the project under which you want to fork.
Options
These are the options supported by the fork
command:
-n, --name <workspace-name>
-n, --name <workspace-name>
The name of the workspace.
-k, --store-private-key <boolean>
-k, --store-private-key <boolean>
Store the private key in the project. Defaults to true.
-w, --workspace <string>
-w, --workspace <string>
Workspace slug to fork the project in
get
get
Usage
Arguments
These are the arguments supported by the get
command:
<project-slug>
<project-slug>
The slug of the project which you want to fetch.
list-forks
list-forks
Usage
Arguments
These are the arguments supported by the list-forks
command:
<project-slug>
<project-slug>
The slug of the project whose forks you want to list.
list
list
Usage
Arguments
These are the arguments supported by the list
command:
<workspace-slug>
<workspace-slug>
The slug of the project whose projects you want.
sync
sync
Usage
Arguments
These are the arguments supported by the sync command:
<project-slug>
<project-slug>
The slug of the forked project that you want to sync with its parent.
Options
These are the options supported by the sync
command:
-h, --hard-sync
-h, --hard-sync
Force the child to match the parent by discarding all changes in the child. Defaults to soft sync.
unlink
unlink
Usage
Arguments
These are the arguments supported by the unlink command:
<project-slug>
<project-slug>
The slug of the forked project that you want to unlink from its parent.
update
update
Usage
Arguments
These are the arguments supported by the update command:
<project-slug>
<project-slug>
The slug of the project that you want to update.
Options
These are the options supported by the update
command:
-n, --name <string>
-n, --name <string>
The name of the project.
-d, --description <string>
-d, --description <string>
Description of the project. Defaults to project name.
-k, --store-private-key
-k, --store-private-key
Store the private key in the project. Defaults to true.
-a, --access-level <string>
-a, --access-level <string>
Access level of the project. Defaults to PRIVATE. Choices are GLOBAL, PRIVATE, INTERNAL.
Last updated
Was this helpful?