Existing Projects

Getting Started

Existing Projects

Adopt an existing repository without losing its working environment, then introduce encrypted state, validation, examples, and team policy in reviewable steps.

Prepare the repository

Start on a dedicated branch with a known-good local .env. Confirm the application boots before migration, verify plaintext env files are ignored, and keep a secure copy outside the repository until the new baseline has been tested.

Preflight
$ git switch -c adopt-ghostable-v3
$ git check-ignore .env
 

Import the first baseline

Initialize from an existing .env
$ ghostable setup --seed-dotenv --create-example --agent-instructions
$ ghostable env diff --env default --file .env
$ ghostable validate --env default
 

Setup encrypts the imported values locally and records the reason as a setup seed. The generated .env.example defaults to retaining non-sensitive example values while blanking values that look sensitive.

Generate an adoption plan

The adopt command produces a plain-text prompt that a developer or coding agent can use to assess schema rules, annotations, example-file drift, hygiene, and optional CI work:

Adoption prompt
$ ghostable adopt --all --ci
 

Treat the prompt as a review aid. It is designed to separate evidence-backed changes from open questions such as secret ownership, deployment scope, and rotation expectations.

Reconcile the project

  1. Compare encrypted state to the working file with env diff.
  2. Add validation rules for values whose format or presence is understood.
  3. Generate .env.example and review every retained example value.
  4. Run ghostable review to find changed-code ENV drift and hard-coded secrets.
  5. Run the application using ghostable env run or a freshly pulled file.
Reconciliation checks
$ ghostable example generate --dry-run
$ ghostable review
$ ghostable env run --env default -- php artisan test
 

Roll out to the team

Commit the reviewed .ghostable/ state, example file, and any agent instructions. Merge the baseline before teammates join so every device request is made against the same project ID and policy.

Continue with Team Onboarding for the join, request, approval, and role-grant workflow.

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