Projects & Setup

Getting Started

Projects & Setup

Organize repositories in the launcher, initialize new Ghostable state, or adopt an existing environment-file workflow safely.

Groups and projects

Launcher groups are local organization only. They are not Ghostable teams, billing seats, or repository permissions, and changing a group does not modify project files. Use them to mirror the way you already think about clients, organizations, or product areas.

Each project record stores a local folder path. Renaming or removing a launcher entry does not rename or delete the repository on disk.

Add a repository

  1. Select the plus button in the Project Launcher.
  2. Create or choose a group.
  3. Add a project and select its repository folder.
  4. Choose Open.

Ghostable checks the selected folder for a .ghostable/ghostable.yaml manifest. A configured repository opens normally; a repository without that manifest opens the setup guide.

Set up Ghostable

The guided setup collects project and local-device details, then lets you choose which adoption steps to perform:

  • Name the first shared environment and choose its environment type.
  • Import an existing local .env file as the initial encrypted baseline.
  • Create or update .env.example.
  • Add managed Ghostable guidance to AGENTS.md.
  • Copy a structured adoption prompt covering schema, annotations, example files, hygiene, drift, and optional CI.
  • Name the device identity created for this project.

Adopt an existing project

When a repository already has environment files, choose one authoritative baseline before importing. Review the file for local-only credentials, stale keys, and values that should never become shared development defaults.

Setup can import the baseline and generate an example file, but it does not decide which values are safe for your team. After setup, inspect every variable, add validation rules, and run Review before committing.

Commit project state

Review the generated files, then commit the .ghostable/ directory through the repository's normal branch and review process. Signed activity, encrypted values, access grants, schemas, and project policy travel with that commit.

Review the initial state
$ git status --short
$ git diff -- .ghostable .env.example AGENTS.md
$ git add .ghostable .env.example AGENTS.md
$ git commit -m "Initialize Ghostable"
 

Open an existing project

Adding an already-configured repository to the launcher does not grant access. This Mac also needs a valid project device identity and environment grants. If the repository was cloned onto a new machine, follow the team onboarding and device join workflow before expecting encrypted values to open.

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