COA Plan
coa_planGenerate a deployment plan by comparing your local project with a target environment and outputting a plan JSON file. Safe, non-destructive preview before applying changes.
Instructions
Generate a deployment plan. Reads the local project, diffs against the target environment, and writes a plan JSON (default coa-plan.json in the project root).
Non-destructive: produces a plan file only. Safe to call without confirmation. The plan is then applied via coa_deploy.
Requires COA cloud credentials (~/.coa/config or profile/token) and an environmentID.
V2 NOTICE: when the project contains V2 artifacts, a V2_DETECTED preflight warning attaches to the result (same shape as coa_create / coa_run). Execution is not blocked; see coalesce://context/sql-node-v2-policy for the two remaining rough edges.
Args:
projectPath (string, required)
environmentID (string, required)
out (string, optional): plan output path
gitsha, enableCache (optional)
profile, token (optional)
Returns: { command, exitCode, stdout, stderr, preflightWarnings?, coaVersion }
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| out | No | Output path for the plan JSON. Relative paths resolve against the project root. Defaults to coa-plan.json in the project root. | |
| token | No | Coalesce refresh token override. Prefer ~/.coa/config over passing tokens through tool input. | |
| gitsha | No | Optional git SHA to embed in the plan manifest. | |
| profile | No | Profile name in ~/.coa/config. Falls back to the COALESCE_PROFILE env var, then to COA's own default (`[default]`). | |
| workspace | No | COA workspace name from workspaces.yml. Defaults to 'dev'. | |
| enableCache | No | Enable coa's plan cache. Coalesce recommends leaving this off unless plan generation is slow. | |
| projectPath | Yes | Absolute or relative path to the COA project root (the directory containing data.yml). | |
| environmentID | Yes | Target environment ID for the deployment plan. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| json | No | ||
| stderr | Yes | ||
| stdout | Yes | ||
| command | Yes | ||
| exitCode | Yes | ||
| timedOut | Yes | ||
| coaVersion | Yes | ||
| jsonParseError | No | ||
| preflightWarnings | No |