mirror of
https://github.com/Infisical/infisical.git
synced 2025-03-31 22:09:57 +00:00
258 lines
6.6 KiB
Plaintext
258 lines
6.6 KiB
Plaintext
---
|
|
title: "infisical secrets"
|
|
description: "Perform CRUD operations with Infisical secrets"
|
|
---
|
|
|
|
```
|
|
infisical secrets
|
|
```
|
|
|
|
## Description
|
|
|
|
This command enables you to perform CRUD (create, read, update, delete) operations on secrets within your Infisical project. With it, you can view, create, update, and delete secrets in your environment.
|
|
|
|
### Sub-commands
|
|
<Accordion title="infisical secrets" defaultOpen="true">
|
|
Use this command to print out all of the secrets in your project
|
|
|
|
```bash
|
|
$ infisical secrets
|
|
```
|
|
|
|
### Environment variables
|
|
|
|
<Accordion title="INFISICAL_TOKEN">
|
|
Used to fetch secrets via a [service token](/documentation/platform/token) apposed to logged in credentials. Simply, export this variable in the terminal before running this command.
|
|
|
|
```bash
|
|
# Example
|
|
export INFISICAL_TOKEN=st.63e03c4a97cb4a747186c71e.ed5b46a34c078a8f94e8228f4ab0ff97.4f7f38034811995997d72badf44b42ec
|
|
```
|
|
|
|
</Accordion>
|
|
|
|
<Accordion title="INFISICAL_DISABLE_UPDATE_CHECK">
|
|
Used to disable the check for new CLI versions. This can improve the time it takes to run this command. Recommended for production environments.
|
|
|
|
To use, simply export this variable in the terminal before running this command.
|
|
|
|
```bash
|
|
# Example
|
|
export INFISICAL_DISABLE_UPDATE_CHECK=true
|
|
```
|
|
|
|
</Accordion>
|
|
|
|
### Flags
|
|
|
|
<Accordion title="--expand">
|
|
Parse shell parameter expansions in your secrets
|
|
|
|
Default value: `true`
|
|
|
|
</Accordion>
|
|
|
|
<Accordion title="--env">
|
|
Used to select the environment name on which actions should be taken on
|
|
|
|
Default value: `dev`
|
|
|
|
</Accordion>
|
|
<Accordion title="--path">
|
|
The `--path` flag indicates which project folder secrets will be injected from.
|
|
|
|
```bash
|
|
# Example
|
|
infisical secrets --path="/" --env=dev
|
|
```
|
|
|
|
</Accordion>
|
|
|
|
</Accordion>
|
|
|
|
<Accordion title="infisical secrets get">
|
|
This command allows you selectively print the requested secrets by name
|
|
|
|
```bash
|
|
$ infisical secrets get <secret-name-a> <secret-name-b> ...
|
|
|
|
# Example
|
|
$ infisical secrets get DOMAIN
|
|
|
|
```
|
|
|
|
### Flags
|
|
|
|
<Accordion title="--env">
|
|
Used to select the environment name on which actions should be taken on
|
|
|
|
Default value: `dev`
|
|
|
|
</Accordion>
|
|
|
|
<Accordion title="--raw-value">
|
|
Used to print the plain value of a single requested secret without any table style.
|
|
|
|
Default value: `false`
|
|
|
|
Example: `infisical secrets get DOMAIN --value`
|
|
|
|
<Tip>
|
|
When running in CI/CD environments or in a script, set `INFISICAL_DISABLE_UPDATE_CHECK` env to `true`. This will help hide any CLI update messages and only show the secret value.
|
|
</Tip>
|
|
|
|
</Accordion>
|
|
</Accordion>
|
|
|
|
<Accordion title="infisical secrets set">
|
|
This command allows you to set or update secrets in your environment. If the secret key provided already exists, its value will be updated with the new value.
|
|
If the secret key does not exist, a new secret will be created using both the key and value provided.
|
|
|
|
```bash
|
|
$ infisical secrets set <key1=value1> <key2=value2>...
|
|
|
|
## Example
|
|
$ infisical secrets set STRIPE_API_KEY=sjdgwkeudyjwe DOMAIN=example.com HASH=jebhfbwe
|
|
```
|
|
|
|
### Flags
|
|
|
|
<Accordion title="--env">
|
|
Used to select the environment name on which actions should be taken on
|
|
|
|
Default value: `dev`
|
|
|
|
</Accordion>
|
|
<Accordion title="--path">
|
|
Used to select the project folder in which the secrets will be set. This is useful when creating new secrets under a particular path.
|
|
|
|
```bash
|
|
# Example
|
|
infisical secrets set DOMAIN=example.com --path="common/backend"
|
|
```
|
|
|
|
</Accordion>
|
|
</Accordion>
|
|
|
|
<Accordion title="infisical secrets delete">
|
|
This command allows you to delete secrets by their name(s).
|
|
|
|
```bash
|
|
$ infisical secrets delete <keyName1> <keyName2>...
|
|
|
|
## Example
|
|
$ infisical secrets delete STRIPE_API_KEY DOMAIN HASH
|
|
```
|
|
|
|
### Flags
|
|
|
|
<Accordion title="--env">
|
|
Used to select the environment name on which actions should be taken on
|
|
|
|
Default value: `dev`
|
|
|
|
</Accordion>
|
|
<Accordion title="--path">
|
|
The `--path` flag indicates which project folder secrets will be injected from.
|
|
|
|
```bash
|
|
# Example
|
|
infisical secrets delete <keyName1> <keyName2>... --path="/"
|
|
```
|
|
|
|
</Accordion>
|
|
</Accordion>
|
|
|
|
<Accordion title="infisical secrets folders">
|
|
This command allows you to fetch, create and delete folders from within a path from a given project.
|
|
|
|
```bash
|
|
$ infisical secrets folders
|
|
```
|
|
|
|
### sub commands
|
|
|
|
<Accordion title="get">
|
|
Used to fetch all folders within a path in a given project
|
|
```
|
|
infisical secrets folders get --path=/some/path/to/folder
|
|
```
|
|
#### Flags
|
|
<Accordion title="--path">
|
|
The path from where folders should be fetched from
|
|
|
|
Default value: `/`
|
|
</Accordion>
|
|
|
|
<Accordion title="--token">
|
|
Fetch folders using the Infisical service token
|
|
|
|
Default value: ``
|
|
</Accordion>
|
|
|
|
</Accordion>
|
|
|
|
<Accordion title="create">
|
|
Used to create a folder by name within a path.
|
|
```
|
|
infisical secrets folders create --path=/some/path/to/folder --name=folder-name
|
|
```
|
|
### Flags
|
|
<Accordion title="--path">
|
|
Path to where the folder should be created
|
|
|
|
Default value: `/`
|
|
</Accordion>
|
|
|
|
<Accordion title="--name">
|
|
Name of the folder to be created in selected `--path`
|
|
|
|
Default value: ``
|
|
</Accordion>
|
|
|
|
</Accordion>
|
|
|
|
<Accordion title="delete">
|
|
Used to delete a folder by name within a path.
|
|
```
|
|
infisical secrets folders delete --path=/some/path/to/folder --name=folder-name
|
|
```
|
|
### Flags
|
|
<Accordion title="--path">
|
|
Path to where the folder should be created
|
|
|
|
Default value: `/`
|
|
</Accordion>
|
|
|
|
<Accordion title="--name">
|
|
Name of the folder to be deleted within selected `--path`
|
|
|
|
Default value: ``
|
|
</Accordion>
|
|
|
|
</Accordion>
|
|
</Accordion>
|
|
|
|
<Accordion title="infisical secrets generate-example-env">
|
|
This command allows you to generate an example .env file from your secrets and with their associated comments and tags. This is useful when you would like to let
|
|
others who work on the project but do not use Infisical become aware of the required environment variables and their intended values.
|
|
|
|
To place default values in your example .env file, you can simply include the syntax `DEFAULT:<value>` within your secret's comment in Infisical. This will result in the specified value being extracted and utilized as the default.
|
|
|
|
```bash
|
|
$ infisical secrets generate-example-env
|
|
|
|
## Example
|
|
$ infisical secrets generate-example-env > .example-env
|
|
```
|
|
|
|
### Flags
|
|
|
|
<Accordion title="--env">
|
|
Used to select the environment name on which actions should be taken on
|
|
|
|
Default value: `dev`
|
|
|
|
</Accordion>
|
|
</Accordion>
|