Keyshade Alpha is launching April 30th 5:00 PM IST
Join our Launch Party
keyshade docs
GithubDiscordReddit
  • 👋What is keyshade?
  • Getting Started
    • Introduction
    • Adding your first secret and variable
    • Installing the CLI
    • Setting up your profile
    • Add keyshade to your project
    • Running your app
  • CLI
    • Introduction
    • Profile
    • Init
    • Workspace
    • Project
    • Environment
    • Run
    • Scan
  • 🥰CONTRIBUTING TO KEYSHADE
    • Summary
    • Design of our code
      • Organization of code
      • API
      • CLI
      • Web
      • Integrations
    • Prerequisites
    • Environment Variables
    • Setting things up
    • Running things locally
      • Running the API
      • Running the Web
      • Running the Platform
      • Running the CLI
      • API Testing
      • Docker Support
  • Internals
    • Architecture of keyshade
    • How the CLI works
Powered by GitBook
On this page
  • Usage
  • Subcommands
  • create
  • Usage
  • Arguments
  • Options
  • delete
  • Usage
  • Arguments
  • fork
  • Usage
  • Arguments
  • Options
  • get
  • Usage
  • Arguments
  • list-forks
  • Usage
  • Arguments
  • list
  • Usage
  • Arguments
  • sync
  • Usage
  • Arguments
  • Options
  • unlink
  • Usage
  • Arguments
  • update
  • Usage
  • Arguments
  • Options

Was this helpful?

Edit on GitHub
  1. CLI

Project

The `project` command

PreviousWorkspaceNextEnvironment

Last updated 3 months ago

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.

Usage

keyshade project <subcommand> [options]

Subcommands

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

Usage

keyshade project create <workspace-slug> [options]

Arguments

These are the arguments supported by the create command:

<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>

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

Usage

keyshade project delete <project-slug> [options]

Arguments

These are the arguments supported by the delete command:

<project-slug>

The slug of the project that you want to delete.

fork

Usage

keyshade project fork <project-slug> [options]

Arguments

These are the arguments supported by the fork command:

<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>

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

Usage

keyshade project get <project-slug> [options]

Arguments

These are the arguments supported by the get command:

<project-slug>

The slug of the project which you want to fetch.

list-forks

Usage

keyshade project list-forks <project-slug> [options]

Arguments

These are the arguments supported by the list-forks command:

<project-slug>

The slug of the project whose forks you want to list.

list

Usage

keyshade project list <workspace-slug> [options]

Arguments

These are the arguments supported by the list command:

<workspace-slug>

The slug of the project whose projects you want.

sync

Usage

keyshade project sync <project-slug> [options]

Arguments

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.

Options

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

Usage

keyshade project unlink <project-slug> [options]

Arguments

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

Usage

keyshade project update <project-slug> [options]

Arguments

These are the arguments supported by the update command:

<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>

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.

create
delete
fork
get
list-forks
list
sync
unlink
update