Skip to main content
Version: 0.0.x

Environment Secrets

Environment secrets are key-value pairs that are securely injected as environment variables into your agent containers at runtime.

List​

List all secret sets.

Usage​

videosdk agent secrets list

Example Output​

$ videosdk agent secrets list

━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
Listing Secrets
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

┌──────────────────┬─────────────────┬──────────┐
│ Name │ Secret ID │ Type │
├──────────────────┼─────────────────┼──────────┤
│ my-secrets │ sec-abc123 │ env │
│ prod-credentials │ sec-xyz789 │ env │
└──────────────────┴─────────────────┴──────────┘

✓ Secrets listed successfully

Create​

Create a new secret set.

Usage​

videosdk agent secrets create <name> [OPTIONS]

Options​

OptionShortDescriptionDefault
--file-fPath to .env file with key=value pairsNone (interactive mode)
--regionRegion for storing secretsNone

Example Output​

$ videosdk agent secrets create my-secrets --file .env

━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
Creating Secret
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

Secret Name: my-secrets
File: .env

Secrets to be saved:
- API_KEY: ******
- DATABASE_URL: ******

Confirm action
❯ Save secrets
Cancel

Saving secrets...
Secrets saved successfully.

✓ Secret 'my-secrets' created successfully

Do you want to add this secret to videosdk.yaml? [y/N]: y
✓ Secret ID saved to videosdk.yaml: <secret-id>

videosdk.yaml Structure​

When saved to videosdk.yaml, the secret ID is added under the secrets section:

secrets:
env: <secret-id>

### Examples

```bash
# Create from .env file
videosdk agent secrets create my-secrets --file .env

# Create interactively (will prompt for key-value pairs)
videosdk agent secrets create my-secrets

# Create with specific region
videosdk agent secrets create my-secrets --file .env --region in002

Add​

Add new keys to an existing secret set.

Usage​

videosdk agent secrets add <name>

Example Output​

$ videosdk agent secrets add my-secrets

━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
Adding to Secret
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

Adding secret...
Enter key: NEW_API_KEY
Enter value: ********

Add another secret?
❯ Yes
No

Secrets to be saved:
- NEW_API_KEY: ******

Confirm action
❯ Save secrets
Cancel

Secret added successfully.

✓ Keys added to secret 'my-secrets' successfully

Remove​

Remove specific keys from a secret set.

Usage​

videosdk agent secrets remove <name>

Example Output​

$ videosdk agent secrets remove my-secrets

━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
Removing Keys from Secret
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

Removing secret...
Enter key: OLD_API_KEY
Remove another key?
❯ Yes
No

Secret removed successfully.

Describe​

Show details of a secret set (keys only, values are hidden).

Usage​

videosdk agent secrets describe <name>

Example Output​

$ videosdk agent secrets describe my-secrets

━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
Describing Secret
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

Name my-secrets
Secret ID sec-abc123
Type env

┌──────────────────┬──────────┐
│ Key │ Value │
├──────────────────┼──────────┤
│ OPENAI_API_KEY │ ****** │
│ DATABASE_URL │ ****** │
│ SECRET_TOKEN │ ****** │
└──────────────────┴──────────┘

Delete​

Permanently delete a secret set.

Usage​

videosdk agent secrets delete <name>

Example Output​

$ videosdk agent secrets delete my-secrets

━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
Deleting Secret
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

✓ Secret 'my-secrets' deleted successfully

This action is permanent and cannot be undone. All keys in the secret set will be deleted.

Using Environment Secrets in Deployments​

Once you've created environment secrets, you can reference them when deploying your agent:

videosdk agent deploy --image myrepo/myagent:v1 --env-secret my-secrets

Got a Question? Ask us on discord