Introduction

​

Setting up

The first step to world-class documentation is setting up your editing environments.

​

What is Ghostable?

Ghostable is a secure environment sharing platform built for Laravel developers. It lets you safely manage, sync, and share .env files across projects and teams—without the mess.

​

Requirements

Ghostable requires that your application be compatible with PHP 8.1+ and Laravel 10.0+.

​

Account Creation

To use Ghostable, start by creating a free account. Every user gets a personal team, where you can create projects and manage environments on your own.You can also join existing teams and contribute to their projects and environments at no cost.

To create and manage shared teams—with multiple members and granular permissions—you’ll need an active Ghostable subscription.

​

Installing the Ghostable CLI

You’ll use the Ghostable CLI to manage, sync, and share environment variables from your local machine. The CLI can be installed globally or on a per-project basis via Composer:

# Install globally
composer global require ghostable-dev/ghostable-cli --update-with-dependencies

# Or install per project
composer require ghostable-dev/ghostable-cli --update-with-dependencies

If installed per project, you’ll run the CLI from the vendor/bin directory. For example, to view available Ghostable commands:

php vendor/bin/ghostable list

To save keystrokes, you can add a shell alias that maps ghostable to php vendor/bin/ghostable:

alias ghostable="php vendor/bin/ghostable"

To learn more about a specific command and its options, use:

ghostable help push

​

Logging In

After installing the Ghostable CLI, authenticate with your Ghostable account using the login command:

ghostable login

​

Teams

When you create a Ghostable account, a Personal team is automatically created for you. This team is private, cannot be renamed or shared, and is perfect for solo projects or personal environments.

All projects and environments in Ghostable belong to a team. You can join other teams as a collaborator, or create your own shared teams to organize work by client, organization, or topic.

Note: Creating a shared team (with invite capabilities) requires a Ghostable subscription.

​

Current Team & Switching Teams

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

ghostable team:current

To switch to another team:

ghostable team:switch

​

Collaborators

You can invite others to your shared teams using the Ghostable UI or the CLI:

ghostable team:add

You’ll be able to assign specific roles and permissions, such as read-only or read-write access to environment variables. To remove a collaborator:

ghostable team:remove

​

Legal and Compliance

Our Terms of Service and Privacy Policy outline the terms, conditions, and privacy practices for using Ghostable.

By using Ghostable, you agree to these policies.