Skip to content

Scenario Commands

Budget scenario CRUD (save, list, compare, delete).

Commands

optimal scenario save

Save current projections as a named scenario

FlagDescriptionDefaultRequired
--name <name>Scenario nameyes
--adjustment-type <type>Adjustment type: percentage or flatyes
--adjustment-value <n>Adjustment valueyes
--description <desc>Description
--fiscal-year <fy>Fiscal year2025
--user-id <uuid>User UUID
bash
optimal scenario save --name "baseline-plus-5" --adjustment-type percentage --adjustment-value 5
optimal scenario save --name "flat-10k" --adjustment-type flat --adjustment-value 10000

optimal scenario list

List all saved budget scenarios

bash
optimal scenario list

optimal scenario compare

Compare two or more scenarios side by side

FlagDescriptionDefaultRequired
--names <csv>Comma-separated scenario namesyes
bash
optimal scenario compare --names "baseline,baseline-plus-5,flat-10k"

optimal scenario delete

Delete a saved scenario

FlagDescriptionDefaultRequired
--name <name>Scenario nameyes
bash
optimal scenario delete --name "old-scenario"

Built by Carlos Lenis in Miami