Get the FREE Ultimate OpenClaw Setup Guide →

vault

npx machina-cli add skill buildoak/fieldwork-skills/vault --openclaw
Files (1)
SKILL.md
9.3 KB

vault

Keep your secrets encrypted. API keys, passwords, tokens -- locked in a vault that only you can open. Your AI agent gets secrets when it needs them, then forgets them.

Script: ./scripts/vault.sh Setup: ./scripts/setup.sh (run once, takes 30 seconds)


Setup

cd /path/to/skills/vault
./scripts/setup.sh
  • Claude Code: copy this skill folder into .claude/skills/vault/
  • Codex CLI: append this SKILL.md content to your project's root AGENTS.md

For the full installation walkthrough (prerequisites, verification, troubleshooting), see references/installation-guide.md.

Staying Updated

This skill ships with an UPDATES.md changelog and UPDATE-GUIDE.md for your AI agent.

After installing, tell your agent: "Check UPDATES.md in the vault skill for any new features or changes."

When updating, tell your agent: "Read UPDATE-GUIDE.md and apply the latest changes from UPDATES.md."

Follow UPDATE-GUIDE.md so customized local files are diffed before any overwrite.


Why this matters

Right now, your secrets probably live in a .env file. Plain text. Anyone who can see your files -- a colleague, a stolen laptop, a backup that leaks, an AI agent that goes rogue -- reads every secret you have.

This vault encrypts them. Even if someone copies your entire hard drive, they can't read your secrets without your encryption key. And your AI agent only sees secrets for the instant it needs them -- they never sit in memory or get written to a file.

Before (plaintext .env):

OPENAI_API_KEY=sk-abc123-real-key-here     <- anyone can read this
DATABASE_URL=postgres://admin:password@...  <- sitting in plain text
STRIPE_SECRET=sk_live_...                   <- one leak away from disaster

After (encrypted vault):

OPENAI_API_KEY: ENC[AES256_GCM,data:8f3k2...]   <- gibberish without your key
DATABASE_URL: ENC[AES256_GCM,data:j4m9x...]      <- encrypted at rest
STRIPE_SECRET: ENC[AES256_GCM,data:p2w7n...]     <- safe even if file leaks

The flow: secret -> encrypt -> vault -> agent needs it -> decrypt to memory -> use -> forget


Quick Start

Three steps. That's it.

1. Run setup

cd path/to/this/skill
./scripts/setup.sh

This installs the encryption tools (if needed), creates your vault, and generates your encryption key. One command, done.

2. Add a secret

./scripts/vault.sh set MY_API_KEY "sk-your-actual-key"

3. Get it back

./scripts/vault.sh get MY_API_KEY

Your vault is working. Secrets are encrypted on disk, decrypted only when you ask for them.


Commands

VAULT="./scripts/vault.sh"

# Store a secret
$VAULT set API_KEY "sk-abc123"

# Retrieve a secret (outputs to stdout, no trailing newline)
$VAULT get API_KEY

# List all secret names (not their values)
$VAULT list

# Export all secrets to your current shell
eval "$($VAULT source)"

# Run a command with secrets injected as env vars
$VAULT exec node server.js

# Check that vault works
$VAULT verify

# Full health check (tools, permissions, encryption test)
$VAULT doctor

# First-time setup
$VAULT setup

# Help for any command
$VAULT get --help
$VAULT set --help
$VAULT exec --help
$VAULT doctor --help

Every command has --help. When something goes wrong, error messages tell you what happened and what to do.


For AI agents

This is the pattern for injecting secrets into AI agent workflows.

Pattern 1: Variable assignment

# Agent needs one secret for a specific command
export TOKEN=$(./scripts/vault.sh get MY_API_KEY)
curl -H "Authorization: Bearer $TOKEN" https://api.example.com
unset TOKEN

Pattern 2: Source all secrets

# Load everything into the current shell
eval "$(./scripts/vault.sh source)"
# Now all secrets are available as env vars
echo $MY_API_KEY  # available
echo $DATABASE_URL  # available

Pattern 3: Scoped execution

# Run a command with secrets -- they don't leak to the parent shell
./scripts/vault.sh exec python my_script.py
# Secrets are gone after the command finishes

Pattern 3 is the safest. Secrets exist only for the duration of the command. They don't linger in your shell's environment. Prefer this when possible.

Agent safety rules

  • Never write secrets to files that get committed to git
  • Never include secrets in prompts or logs
  • Prefer vault.sh exec over eval "$(vault.sh source)" when possible
  • After using eval source, clean up with unset for sensitive vars

Configuration

All paths are configurable via environment variables:

VariableDefaultWhat it controls
VAULT_DIR~/.shitWhere the vault lives
VAULT_FILE$VAULT_DIR/vault.enc.yamlThe encrypted secrets file
SOPS_AGE_KEY_FILE$VAULT_DIR/.age-identityYour encryption key

Customize the vault path. The default (~/.shit) is intentionally misleading -- it's an extra layer of obscurity on top of the real encryption. Pick something that makes sense for your setup. Some options:

# In your shell profile (~/.zshrc or ~/.bashrc):
export VAULT_DIR="$HOME/.config/vault"     # conventional
export VAULT_DIR="$HOME/.cache/.internal"   # hidden in cache
export VAULT_DIR="$HOME/.local/secrets"     # descriptive

Then re-run setup: VAULT_DIR="$HOME/.config/vault" ./scripts/setup.sh


How it works (under the hood)

Two tools do the heavy lifting:

  • age -- Modern encryption. Creates a key pair (public + private). Your secrets are encrypted with the public key and can only be decrypted with the private key. No passwords to remember.
  • sops -- Wraps age to encrypt individual fields in a YAML file. Each secret value is encrypted separately, but key names stay visible (so you can see what's in the vault without decrypting).

The vault directory looks like this:

~/.shit/                    chmod 700 (only you can access)
  .age-identity             Your encryption key (chmod 600)
  vault.enc.yaml            Your encrypted secrets
  .sops.yaml                Config telling sops which key to use

Key security facts:

  • Secrets are encrypted with X25519 (the elliptic-curve key-exchange algorithm Signal uses)
  • Decrypted values only exist in memory -- stdout, pipes, env vars
  • Nothing writes plaintext to disk, ever
  • The vault.sh script validates all input to prevent injection attacks
  • File permissions are checked and auto-fixed on every operation

What this protects against (and what it doesn't)

Protected:

  • Casual file browsing (encrypted, not readable)
  • Accidental git commits (encrypted file is safe to commit, though not recommended)
  • Laptop theft (encrypted without the key is useless)
  • AI agent data exfiltration (secrets aren't in plaintext files)
  • Plaintext exposure in logs or backups

NOT protected:

  • Someone with access to your logged-in user account (they can run vault.sh)
  • Physical access to your unlocked computer
  • Malware running as your user (it can read the key file)
  • Key compromise (if someone gets .age-identity, they get everything)

Bottom line: This is dramatically better than .env files. It's not a replacement for a dedicated secrets manager in production infrastructure (use HashiCorp Vault, AWS Secrets Manager, etc. for that). It's for your development machine, your personal API keys, your local credentials.


Error Handling

ProblemSolution
sops not foundbrew install sops (Mac) or see sops install guide
age not foundbrew install age (Mac) or see age install guide
jq not foundbrew install jq (Mac) or sudo apt install jq (Linux)
Age identity not foundRun ./scripts/setup.sh to create it
Vault decrypted but no secrets foundNormal for a fresh vault -- add a secret with vault.sh set
Failed to set keyCheck that key name uses only letters, digits, and underscores
Key not foundRun vault.sh list to see available keys
Permission deniedRun vault.sh doctor to check and fix permissions
Everything brokenRun vault.sh doctor -- it checks everything and tells you what's wrong

Anti-Patterns

Do NOTDo instead
Store secrets in .env plaintext filesStore secrets with ./scripts/vault.sh set ...
Leave secrets exported in shell for long sessionsPrefer ./scripts/vault.sh exec <command> for scoped access
Print secrets to logs or command historyUse env vars and avoid echoing secret values
Commit decrypted outputs or temp filesKeep secrets encrypted at rest and out of git
Skip vault.sh doctor when setup failsRun vault.sh doctor first, then fix reported issues

Bundled Resources Index

PathWhatWhen to load
./references/installation-guide.mdDetailed install walkthrough for Claude Code and Codex CLIFirst-time setup or environment repair
./scripts/vault.shVault CLI -- the main interfaceAlways
./scripts/setup.shFirst-time setup scriptInitial setup only

Source

git clone https://github.com/buildoak/fieldwork-skills/blob/main/skills/vault/SKILL.mdView on GitHub

Overview

vault is an encrypted storage for API keys, passwords, and tokens used by AI coding agents. It stores secrets securely with age-based public-key encryption and sops-encrypted YAML files so secrets are never kept as plaintext.

How This Skill Works

Secrets are added via the vault.sh script and stored encrypted on disk. When an agent needs a secret, vault decrypts it into memory for immediate use and never leaves plaintext on disk or in logs; memory is cleared after use.

When to Use It

  • Securely store API keys, passwords, and tokens for AI agents instead of plaintext .env files.
  • Provide secrets to an agent only when needed, preventing long-term exposure and memory storage.
  • Inject secrets into a workflow via environment variables or commands (Pattern 1/2).
  • Export all secrets to the current shell or run a process with secrets injected (vault exec or source).
  • Keep secrets updated with UPDATES.md and apply changes using UPDATE-GUIDE.md during maintenance.

Quick Start

  1. Step 1: Run setup - cd path/to/this/skill && ./scripts/setup.sh
  2. Step 2: Add a secret - ./scripts/vault.sh set MY_API_KEY "sk-your-actual-key"
  3. Step 3: Get it back - ./scripts/vault.sh get MY_API_KEY

Best Practices

  • Encrypt secrets at rest and decrypt only in memory for use.
  • Keep your encryption key secure and never embed it in code.
  • Never log or persist decrypted secrets; use vault source or env injection carefully.
  • Follow the provided UPDATES.md and UPDATE-GUIDE.md when upgrading.
  • Prefer using vault set/get and vault exec to minimize exposure and scope.

Example Use Cases

  • Store OPENAI_API_KEY safely and fetch it when making API calls.
  • Store DATABASE_URL and inject it into a Node.js service at startup.
  • Keep STRIPE_SECRET encrypted and access only during payment processing.
  • Use token retrieval to run curl requests with Authorization headers without writing keys to files.
  • Inject multiple secrets into a CLI tool without leaking them to logs.

Frequently Asked Questions

Add this skill to your agents
Sponsor this space

Reach thousands of developers