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
  • Options
  • -w, --workspace <workspace>
  • -p, --project <project>
  • -e, --environment <environment>
  • -k, --private-key <key>
  • -o, --overwrite

Was this helpful?

Edit on GitHub
  1. CLI

Init

The `init` command

The init command is used to initialize your project to tap into the live updates from our platform. This command creates a keyshade.json file in your project root. This file contains the following information:

Usage

keyshade init [options]

Options

These are the commands supported by the init command:

-w, --workspace <workspace>

The workspace name whose updates you want to tap into.

-p, --project <project>

The project name whose updates you want to tap into. Note that this project must be under the specified workspace.

-e, --environment <environment>

The environment name whose updates you want to tap into. Note that this environment must be under the specified project.

-k, --private-key <key>

The private key for the project+environment pair. This key is used to decrypt the secrets that are sent to your application.

-o, --overwrite

This flag is used to overwrite the existing keyshade.json file in the project root. The default is false.

PreviousProfileNextWorkspace

Last updated 10 months ago

Was this helpful?