Agent Integration

Reference

Agent Integration

Give coding agents enough Ghostable context to inspect configuration safely while keeping mutation, plaintext output, access changes, and deployments under explicit human authority.

Install project guidance

Write Ghostable's maintained guidance into the repository's AGENTS.md:

Agent instructions
$ 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
$ 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
$ 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
$ 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

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
$ 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.

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