Quick Start

This tutorial gets envlock working end-to-end in a few minutes.

Prerequisites

• You can run shell commands in bash, zsh, or compatible shells.
• You have either:
  • the envlock binary installed, or
  • the source repository and Rust toolchain.

Step 1: Create a Profile

Create quickstart.json:

{
  "injections": [
    {
      "type": "env",
      "vars": {
        "ENVLOCK_PROFILE": "quickstart",
        "KUBECONFIG_CONTEXT": "dev-cluster"
      },
      "ops": [
        {
          "op": "prepend",
          "key": "PATH",
          "value": "~/.local/bin",
          "separator": "os",
          "dedup": true
        }
      ]
    }
  ]
}

Step 2: Preview Output

envlock -p quickstart.json --output shell

Expected shape:

export ENVLOCK_PROFILE='quickstart'
export KUBECONFIG_CONTEXT='dev-cluster'

Step 3: Apply in Current Shell

eval "$(envlock -p quickstart.json)"
echo "$ENVLOCK_PROFILE"

You should see quickstart.

Step 4: Run in Command Mode

Command mode injects variables only into the child process:

envlock -p quickstart.json -- bash -lc 'echo "$ENVLOCK_PROFILE"'

This prints quickstart without mutating your parent shell.

Next

• Learn profile resolution with --use in Use Profiles.
• Review all options in CLI Reference.