Agent Integration | Ghostable CLI 3.x | Ghostable Menu Agent Integration Install project guidance ------------------------ Write Ghostable's maintained guidance into the repository's `AGENTS.md`: Agent instructions Copy ``` $ ghostable agent init --dry-run $ ghostable agent init $ ghostable agent instructions ``` Setup can perform the same integration with `--agent-instructions`. Review generated guidance before committing it, especially when the repository already has agent rules. Safe default capabilities ------------------------- `agent capabilities` emits the recommended allowlist for default agent behavior: Capability inventory Copy ``` $ ghostable agent capabilities $ ghostable agent capabilities --json ``` The list favors status, lists, redacted diffs, history, validation, review, hygiene, and dry-run pull or deploy planning. It is not the complete CLI inventory. Read-only investigation ----------------------- Agent-safe investigation Copy ``` $ ghostable status --json $ ghostable env list --json $ ghostable env diff --from staging --to production --json $ ghostable validate --env staging --json $ ghostable review --secrets-only --json $ ghostable access matrix --json ``` Agents should prefer structured output, state assumptions explicitly, and avoid extrapolating plaintext values from metadata. Mutating workflows ------------------ Pushing, syncing, promoting, deleting, rotating, approving access, revoking devices, pulling to a file, and deploying all change state or expand plaintext exposure. An agent should perform them only when the user explicitly requests that operation and should dry-run or diff first where available. Review before mutation Copy ``` $ ghostable env diff --env staging --file .env.staging --json $ ghostable validate --env staging --json $ ghostable env push --env staging --file .env.staging --reason "Requested configuration update" --json ``` Secret handling --------------- Do not reveal values by default Agents should not add `--show-values`, print env files, echo process variables, paste tokens into commands, or include plaintext in summaries. A user request to change a value is not automatically a request to display it. Prefer file-based input for non-interactive `var push`, redacted JSON diffs, `env run --mask-output`, and scoped automation credentials. Treat terminal output and tool logs as possible disclosure channels. Adopting existing projects -------------------------- Generate a structured adoption prompt for an agent or developer: Adoption analysis Copy ``` $ ghostable adopt --sections schema,annotations,example,hygiene,drift,ci ``` The generated prompt emphasizes evidence-backed, non-secret metadata and moves uncertain ownership, deployment, visibility, and rotation questions into an explicit open-questions list. On this page [ ![Ghostable](https://ghostable.dev/images/logo-dark.svg) ![Ghostable](https://ghostable.dev/images/logo-light.svg) ](https://ghostable.dev) CLI 3.x [ CLI 3.x ](https://ghostable.dev/docs/3.x) [ Desktop ](https://ghostable.dev/docs/desktop) CLI 3.x introduction Documentation local first no login encrypted repository plaintext hosted service Installation Documentation brew homebrew npm npx linux windows PATH version update Start a new project Getting Started setup seed dotenv owner initialize Adopt an existing project Getting Started existing env import authoritative source adopt Onboard a team member Getting Started join request approve roles offboarding pull request Repository and storage Core Concepts .ghostable git conflict merge worktree private identity metadata Environments Core Concepts protected production preview staging push sync pull replace run mask-output Variables and promotions Core Concepts var promote copy context annotation key Access and devices Core Concepts identity reader writer grantor owner revoke rotate leave delete Daily development workflow Workflows pull diff validate review clean daily Review and secret scanning Workflows scan sarif github suppress secrets drift Hygiene and rotation Workflows rotation stale unused suppression environment key Automation credentials Automation & CI GHOSTABLE\_CI\_TOKEN ci deploy credential powershell revoke replace Continuous integration Automation & CI GitHub Actions fork pull request JSON stdout stderr exit codes mask-output Deployments Automation & CI Forge Vapor Cloud provider CLI dry-run preserve remote keys temporary files Validation Reference schema required nullable regex min max different\_from Command reference Reference --help --json NO\_COLOR flags aliases exit code automation Configuration Reference ghostable.yaml activity mode auditEnvironments scan ignores deployTarget dotenv syntax Security Reference cryptography XChaCha20 Poly1305 HKDF user presence threat model Backups & Offline Reference recovery offline restore clone key identity Agent integration Reference AGENTS.md capabilities allowlist coding agent Troubleshooting Reference no project found revoked identity stale policy user presence invalid CI token provider CLI git conflict diagnostics 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