Installation | Ghostable CLI 3.x | Ghostable                              Menu

 Installation

   macOS
-----

The Homebrew cask installs the signed and notarized macOS release:

 Homebrew     Copy

 ```
$ brew tap ghostable-dev/ghostable
$ brew install --cask ghostable

```

The global binary is available as `ghostable` from any project directory.

 npm projects
------------

 Install the CLI as a project dependency when you want every developer and CI job to use the version declared by the repository:

 npm     Copy

 ```
$ npm install @ghostable/cli

```

 npm places the binary at `node_modules/.bin/ghostable`. npm scripts resolve that binary automatically; outside a script, use `npx ghostable` or invoke the binary directly.

 Linux and Windows
-----------------

 Ghostable publishes release archives for macOS, Linux, and Windows on both `amd64` and `arm64`. Download the archive matching your operating system and architecture from the [latest GitHub release](https://github.com/ghostable-dev/ghostable/releases/latest), extract the binary, and place it on `PATH`.

 On Linux and other Unix systems, make the extracted file executable before moving it to a directory on `PATH`. On Windows, place `ghostable.exe` in a directory included in the user or system `PATH`.

 Verify the installation
-----------------------

 Verify Ghostable     Copy

 ```
$ ghostable --version
$ ghostable --help
 3.x.x

```

 If multiple copies are installed, confirm the executable resolved by your shell with `which ghostable` on macOS/Linux or `where ghostable` on Windows. A project-local npm installation may intentionally differ from a global installation.

 Updating
--------

 Update Ghostable     Copy

 ```
$ # Homebrew
$ brew upgrade --cask ghostable
$ # npm
$ npm install @ghostable/cli@latest

```

Commit npm lockfile changes so the team and CI resolve the same CLI release.

    On this page

    [ ![Ghostable](https://ghostable.dev/images/logo-dark.svg) ![Ghostable](https://ghostable.dev/images/logo-light.svg) ](https://ghostable.dev)

   CLI 3.x     [   CLI 3.x ](https://ghostable.dev/docs/3.x) [   Desktop ](https://ghostable.dev/docs/desktop)

  CLI 3.x introduction Documentation local first no login encrypted repository plaintext hosted service

  Installation Documentation brew homebrew npm npx linux windows PATH version update

  Start a new project Getting Started setup seed dotenv owner initialize

  Adopt an existing project Getting Started existing env import authoritative source adopt

  Onboard a team member Getting Started join request approve roles offboarding pull request

  Repository and storage Core Concepts .ghostable git conflict merge worktree private identity metadata

  Environments Core Concepts protected production preview staging push sync pull replace run mask-output

  Variables and promotions Core Concepts var promote copy context annotation key

  Access and devices Core Concepts identity reader writer grantor owner revoke rotate leave delete

  Daily development workflow Workflows pull diff validate review clean daily

  Review and secret scanning Workflows scan sarif github suppress secrets drift

  Hygiene and rotation Workflows rotation stale unused suppression environment key

  Automation credentials Automation & CI GHOSTABLE\_CI\_TOKEN ci deploy credential powershell revoke replace

  Continuous integration Automation & CI GitHub Actions fork pull request JSON stdout stderr exit codes mask-output

  Deployments Automation & CI Forge Vapor Cloud provider CLI dry-run preserve remote keys temporary files

  Validation Reference schema required nullable regex min max different\_from

  Command reference Reference --help --json NO\_COLOR flags aliases exit code automation

  Configuration Reference ghostable.yaml activity mode auditEnvironments scan ignores deployTarget dotenv syntax

  Security Reference cryptography XChaCha20 Poly1305 HKDF user presence threat model

  Backups & Offline Reference recovery offline restore clone key identity

  Agent integration Reference AGENTS.md capabilities allowlist coding agent

  Troubleshooting Reference no project found revoked identity stale policy user presence invalid CI token provider CLI git conflict diagnostics

  Ghostable Desktop overview Desktop

  Installation Desktop

  Projects and setup Desktop

  Interface tour Desktop

  Environments and variables Desktop

  Local environment files Desktop

  Validation and review Desktop

  Activity Desktop

  Access and automation Desktop

  Project settings Desktop

  Application settings Desktop

  Licensing and updates Desktop

  Security and storage Desktop

  Troubleshooting Desktop    No results found