Installation

Getting Started

Installation

Install Ghostable CLI 3.x on macOS, Linux, or Windows, then verify which binary your project is using.

macOS

The Homebrew cask installs the signed and notarized macOS release:

Homebrew
$ 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
$ 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, 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
$ 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
$ # 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.

CLI 3.x introduction Documentation
Installation Documentation
Start a new project Getting Started
Adopt an existing project Getting Started
Onboard a team member Getting Started
Repository and storage Core Concepts
Environments Core Concepts
Variables and promotions Core Concepts
Access and devices Core Concepts
Daily development workflow Workflows
Review and secret scanning Workflows
Hygiene and rotation Workflows
Automation credentials Automation & CI
Continuous integration Automation & CI
Deployments Automation & CI
Validation Reference
Command reference Reference
Configuration Reference
Security Reference
Backups & Offline Reference
Agent integration Reference
Troubleshooting Reference
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