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

Was this helpful?

Edit on GitHub
  1. CLI

Profile

The `profile` command

PreviousIntroductionNextInit

Last updated 10 months ago

Was this helpful?

The profile command is used to manage all the profiles in the CLI. A profile is a collection of configurations that are used to interact with the keyshade API. It has a set of subcommands:

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

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

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

  • : This command is used to list all the profiles.

  • : This command is used to set a default profile.

Usage

keyshade profile <subcommand> [options]

create

Usage

keyshade profile create [options]

Options

These are the commands supported by the create command:

-n, --name <name>

The name of the profile. This is a required field.

-a, --api-key <key>

The API key to use with this profile. This is a required field.

-b, --base-url <url>

The base URL of the API to use with this profile. The default is https://api.keyshade.xyz.

--set-default

If set, this profile will be set as the default profile. Default is false.

update

Usage

keyshade profile update <profile> [options]

Arguments

These are the arguments supported by the update command:

<profile>

The name of the profile to update.

Options

These are the commands supported by the update command:

-n, --name <name>

The new name of the profile.

-a, --api-key <key>

The new API key to use with this profile.

-b, --base-url <url>

The new base URL of the API to use with this profile.

delete

Usage

keyshade profile delete <profile> [options]

Arguments

These are the arguments supported by the delete command:

<profile>

The name of the profile to delete.

list

Usage

keyshade profile list [options]

Options

These are the commands supported by the list command:

-v, --verbose

If set, the output will list out the API keys and base URLs as well. Default is false.

use

Usage

keyshade profile use <profile> [options]

Arguments

These are the arguments supported by the use command:

<profile>

The name of the profile to set as the default profile.

create
update
delete
list
use