Socotra
CLI · command

socotra plan

Preview the changes apply would make without modifying the filesystem.

Synopsis

socotra plan [--output text|json] [--detailed-exit-codes]

Options

OptionTypeDefaultDescription
--outputtext | jsontextOutput format
--detailed-exit-codesboolfalseDistinguish changes-pending from no-changes

Exit codes

CodeMeaning
0No changes pending (or pending without --detailed-exit-codes)
1Error during plan computation
2Changes pending (only with --detailed-exit-codes)

Behavior

  • Shows a spinner while computing the plan.
  • Displays a colour-coded table of steps (add / modify / destroy).
  • Never writes to disk.

Examples

socotra plan
socotra plan --output json
socotra plan --detailed-exit-codes
plan output
{
  "summary": { "toAdd": 3, "toModify": 1, "toDestroy": 0 },
  "steps": [
    {
      "type": "AddProject",
      "risk": "Low",
      "description": "Create project 'MyApp.Orders.Domain' as ClassLib"
    },
    {
      "type": "AddPackage",
      "risk": "Low",
      "description": "Add FluentValidation v11.9.2 to MyApp.Orders.Application"
    }
  ]
}
Schema 1.1 · CLI 1.0
Previoussocotra validateNext socotra apply