Documentation
Ghostable CLI 3.x
Local-first environment management for teams that want encrypted, reviewable configuration without sending plaintext secrets to a hosted secrets service.
What Ghostable does
Ghostable stores encrypted environment values and the signed records needed to manage them inside your project repository. The CLI creates environments, encrypts and decrypts values, validates configuration, reviews code for environment drift and hard-coded secrets, and prepares values for local processes or deployment providers.
There is no Ghostable login and no hosted Ghostable vault in the v3 architecture. Your repository carries the encrypted project state; each authorized device keeps its private identity outside the repository.
How it works
- Initialize a repository.
ghostable setupcreates a project manifest, the first device identity, environment keys, policy, and signed activity state. - Commit encrypted state. The
.ghostable/directory is designed to travel through Git and code review. Plaintext.envfiles are not. - Grant access by device. New team members create their own device identities and request a role for one or more environments.
- Work locally. Pull to a file only when necessary, or inject values directly into a command with
env run. - Review every change. Signed value history, validation, hygiene reports, and secret scanning make environment changes visible without disclosing secret contents.
A typical workflow
A normal development loop is intentionally small:
$ ghostable status
$ ghostable env diff --env default --file .env
$ ghostable env push --env default --file .env --reason "Update local configuration"
$ ghostable validate --env default
$ ghostable review
$ git add .ghostable && git commit -m "Update encrypted environment"
Commands prompt for missing choices in an interactive terminal. Scripts, CI jobs, and coding agents should pass explicit flags and prefer --json output.
CLI and Desktop
The CLI is Ghostable's versioned engine and the source of truth for project behavior. Ghostable Desktop is a paid macOS interface that runs the CLI underneath, so encryption, repository formats, access rules, and command behavior remain consistent between both products.
Use these versioned 3.x docs for the shared engine. Use the Desktop documentation for installation, application diagnostics, and interface-specific guidance.
Where to begin
- Install the CLI using the installation guide.
- Use New Projects when no Ghostable state exists yet.
- Use Existing Projects to adopt a repository that already has one or more
.envfiles. - Read Team Onboarding before adding a second developer.
- Review the Security page before using Ghostable for production credentials.