Lockr CLI

A command-line interface for managing secrets with LockrDev.

Installation

npm install -g @lockr-dev/cli
# or
npx @lockr-dev/cli

Authentication

First, create an API token in the Lockr dashboard:

1. Go to Integrations → API Tokens (Pull)
2. Click Create API Token
3. Copy your token

Then authenticate:

lockr auth login --token YOUR_API_TOKEN
# or set the environment variable
export LOCKR_API_TOKEN=YOUR_API_TOKEN

Commands

Pull Secrets

Pull secrets from Lockr to your local environment:

# Pull all secrets for production
lockr pull --env production

# Pull to a specific file
lockr pull --env production --output .env

# Pull specific keys only
lockr pull --env production --keys API_KEY,DATABASE_URL

# Output as JSON
lockr pull --env production --format json

Run with Secrets

Run a command with secrets injected as environment variables:

# Run your app with production secrets
lockr run --env production -- npm start

# Run with staging secrets
lockr run --env staging -- docker-compose up

List Environments

lockr envs list

Whoami

Check your current authentication:

lockr whoami

Configuration

Create a .lockrrc file in your project root:

{
  "project": "my-project",
  "defaultEnv": "development"
}

CI/CD Usage

GitHub Actions

steps:
  - name: Pull secrets
    run: npx @lockr-dev/cli pull --env production --output .env
    env:
      LOCKR_API_TOKEN: ${{ secrets.LOCKR_API_TOKEN }}

GitLab CI

deploy:
  script:
    - npx @lockr-dev/cli pull --env production --output .env
    - docker build -t myapp .
  variables:
    LOCKR_API_TOKEN: $LOCKR_API_TOKEN

CircleCI

jobs:
  build:
    steps:
      - run:
          name: Pull secrets
          command: npx @lockr-dev/cli pull --env production --output .env

Environment Variables

| Variable | Description | |----------|-------------| | LOCKR_API_TOKEN | Your API token for authentication | | LOCKR_API_URL | Custom API URL (default: production) | | LOCKR_PROJECT | Default project to use |

License

MIT