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.
$ git switch -c adopt-ghostable-v3
$ git check-ignore .env
Import the first baseline
$ 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:
$ 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
- Compare encrypted state to the working file with
env diff. - Add validation rules for values whose format or presence is understood.
- Generate
.env.exampleand review every retained example value. - Run
ghostable reviewto find changed-code ENV drift and hard-coded secrets. - Run the application using
ghostable env runor a freshly pulled file.
$ 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.