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
  • create
  • Usage
  • Arguments
  • Options
  • delete
  • Usage
  • Arguments
  • get
  • Usage
  • Arguments
  • list
  • Usage
  • Arguments
  • Options
  • update
  • Usage
  • Arguments
  • Options

Was this helpful?

Edit on GitHub
  1. CLI

Environment

The `environment` command

PreviousProjectNextRun

Last updated 7 months ago

Was this helpful?

The environment command is used to manage environments in Keyshade. An environment is a context in which secrets and variables are stored and accessed. It has a set of subcommands:

  • : This command is used to create a new environment.

  • : This command is used to delete an existing environment.

  • : This command is used to get details of a specific environment.

  • : This command is used to list all environments.

  • : This command is used to update the properties of an existing environment.

Usage

keyshade environment <subcommand> [options]

create

Usage

keyshade environment create <project-slug> [options]

Arguments

These are the arguments supported by the create command:

<project-slug>

The slug of the project under which you want to add the environment.

Options

These are the options supported by the create command:

-n, --name <string>

The name of the environment.

-d, --description <string>

A description of the environment.

delete

Usage

keyshade environment delete <environment-id> [options]

Arguments

These are the arguments supported by the delete command:

<environment-id>

The ID of the environment which you want to delete.

get

Usage

keyshade environment get <environment-slug> [options]

Arguments

These are the arguments supported by the get command:

<environment-slug>

Slug of the environment which you want to fetch.

list

Usage

keyshade environment list <project-slug> [options]

Arguments

These are the arguments supported by the list command:

<project-slug>

Slug of the project whose environments you want.

Options

These are the options supported by the list command:

PAGINATION_OPTION

The list command supports pagination options. These options are defined in the PAGINATION_OPTION constant.

update

Usage

keyshade environment update <environment-slug> [options]

Arguments

These are the arguments supported by the update command:

<environment-slug>

Slug of the environment which you want to update.

Options

These are the options that might be supported by the update command:

-n, --name <string>

The new name for the environment.

-d, --description <string>

The new description for the environment.

create
delete
get
list
update