Skip to main content

​
Account Creation

Before integrating Ghostable into your workflow, you’ll first need to create a Ghostable account. If you’re collaborating on projects managed by others, a Ghostable subscription isn’t necessary.

Start with a free Ghostable account

Setup takes less than a minute.

​
Requirements

System
  • Node.js 20 LTS (18+ supported) — macOS, Linux, or Windows.
  • No PHP required for standard Ghostable CLI operations.
Laravel
  • Ghostable supports Laravel applications compatible with PHP 8.1+ and Laravel 10.0+.
  • These requirements only apply if you are using Ghostable’s Laravel-specific deployment commands.
  • In all other cases, Ghostable runs fully standalone as a Node-based CLI.

​
Installing the Ghostable CLI

You will interact with your Ghostable environments using the Ghostable CLI. The CLI can be installed globally or on a per-project basis using npm: 
# Per-project
npm install ghostable/cli@latest

# Global
npm install -g ghostable/cli@latest
To save keystrokes, you can add a shell alias that maps ghostable to npx ghostable. This allows you to run ghostable directly without prefixing every command.

​
Logging In

After installing the Ghostable CLI, authenticate with your Ghostable account using the login command: 
ghostable login
You’ll be prompted for:
  • Email address
  • Password (hidden)
  • 2FA Code (if enabled)

​
Exploring Commands

To view all available Ghostable CLI commands, run: 
ghostable --help
To explore a specific command and its available options, use the —help flag after the command name: 
ghostable env:push --help

​
Organizations

When you create a Ghostable account, your first step is to create an organization. Organizations act as containers for your projects and environments, and you can belong to multiple organizations to collaborate with different groups or clients. All projects and environments in Ghostable belong to an organization. You can join other organizations as a collaborator or create your own to organize work by client or topic.

​
Listing Organizations

To view all organizations you belong to: 
ghostable organization:list

​
Current Organization & Switching Organizations

When working with the Ghostable CLI, you’ll often need to know which organization is currently active. To check your current organization: 
ghostable organization:current
To switch to another organization: 
ghostable organization:switch