Skip to main content

definition

Manage secret definitions for a project. Secret definitions document the expected keys, their descriptions, and whether they are required — without storing values.

definition list

envshed definition list [options]

Lists all secret definitions for the project.

Options

OptionDescription
-o, --org <slug>Organization slug
-p, --project <slug>Project slug
--output jsonPrint JSON output

definition create

envshed definition create <KEY> [options]

Creates a new secret definition for the given key.

Options

OptionDescription
-d, --description <text>Description of the secret
--requiredMark the secret as required
-o, --org <slug>Organization slug
-p, --project <slug>Project slug
--output jsonPrint JSON output

definition update

envshed definition update <KEY> [options]

Updates an existing secret definition. At least one of --description or --required/--no-required must be provided.

Options

OptionDescription
-d, --description <text>New description
--required / --no-requiredSet or unset the required flag
-o, --org <slug>Organization slug
-p, --project <slug>Project slug
--output jsonPrint JSON output

definition delete

envshed definition delete <KEY> [options]

Deletes a secret definition. Prompts for confirmation unless --yes is passed. A warning is shown if active secrets use this key.

Options

OptionDescription
-o, --org <slug>Organization slug
-p, --project <slug>Project slug
-y, --yesSkip confirmation prompt
--output jsonPrint JSON output