> ## Documentation Index
> Fetch the complete documentation index at: https://docs.ghostable.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Introduction

> Secure, share, and validate your Laravel environment variables with Ghostable—and experience the peace of mind and simplicity of effortless, collaborative configuration management.

<Warning>
  Ghostable CLI 1.x is legacy. Prefer the current [Desktop
  docs](/desktop/v1/getting-started/overview) or [CLI 2.x
  docs](/cli/v2/getting-started/installation) for new work.
</Warning>

<CardGroup cols={2}>
  <Card title="Create an Account" icon="user-plus" href="https://ghostable.dev/register">
    Create you Ghostable account today
  </Card>

  <Card title="Learn More" icon="circle-info" href="https://ghostable.dev/">
    Learn more about the Ghostable platform
  </Card>
</CardGroup>

## What is Ghostable?

Ghostable is a secure, collaborative platform for managing, validating, and sharing environment
variables in Laravel applications. Ghostable simplifies configuration management, enabling you to
effortlessly secure and scale your development workflows.

Ghostable abstracts the complexity of securely handling sensitive environment data, ensuring
consistency and compliance across your projects and organizations. With Ghostable, you'll benefit
from:

* **Secure Sharing & Management**: Safely share environment variables across organizations,
  projects, and CI/CD pipelines.
* **Built-In Validation**: Automatically enforce validation rules to ensure your environment
  variables adhere to best practices.
* **Comprehensive Versioning**: Track every change with full history and instant rollbacks to
  previous environment configurations.
* **Granular Access Control**: Precisely manage permissions at the user, organization, and project
  level.
* **Encrypted Storage**: All environment variables are stored securely using industry-standard
  AES-256-GCM encryption.
* **CI/CD Integration**: Seamlessly integrate Ghostable into your automated testing and deployment
  workflows.
* **Activity Logging**: Complete audit trails of environment variable interactions for compliance
  and security audits.
* **Easy Local Inspection**: Effortlessly pull environment variables locally for debugging and
  testing.
* **API Driven**: Full-featured API to integrate with third-party compliance tools, monitoring
  platforms, and AI-powered workflows.
* **Customizable Validation**: Define custom validation rules to meet the unique requirements of
  your environments.

In short, you can think of Ghostable as your central hub for secure, compliant, and collaborative
environment variable management—built specifically with Laravel developers in mind.

## Requirements

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

## 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 here: [Register for Ghostable](https://ghostable.dev/register)

## Installing the Ghostable CLI

You will interact with your Ghostable environments using the
[Ghostable CLI](https://github.com/ghostable-dev/cli). The CLI can be installed globally or on a
per-project basis using Composer:

### Per-project installation:

```bash theme={null}
composer require ghostable-dev/cli --update-with-dependencies
```

***

### Global installation:

```bash theme={null}
composer global require ghostable-dev/cli --update-with-dependencies
```

***

When installing the CLI per-project, you’ll typically execute it via your project’s vendor/bin
directory, where Composer installs executables. For example, to view all available Ghostable CLI
commands:

```bash theme={null}
php vendor/bin/ghostable list
```

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

```bash theme={null}
alias ghostable="php vendor/bin/ghostable"
```

***

### Exploring Commands

To explore a command’s functionality and its arguments in detail, use the help command with the
specific command name:

```bash theme={null}
ghostable help env:push
```

## Logging In

After installing the [Ghostable CLI](https://github.com/ghostable-dev/cli), authenticate with your
Ghostable account using the `login` command:

```bash theme={null}
ghostable login
```

You'll be prompted for:

* Email address
* Password (hidden)

## 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:

```bash theme={null}
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:

```bash theme={null}
ghostable organization:current
```

To switch to another organization:

```bash theme={null}
ghostable organization:switch
```

***

### Collaborators

You can invite others to your organizations using the Ghostable web app:

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

## Legal and Compliance

Our [Terms of Service](https://ghostable.dev/terms) and
[Privacy Policy](https://ghostable.dev/privacy) outline the terms, conditions, and privacy practices
for using Ghostable.

By using Ghostable, you agree to these policies.