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