Skip to content

Plan

terminal
codify plan
[--json]
[--debug]
[-o plain|default|debug|json]
[-s]
[-p <value>]

Use codify plan to generate a plan from the config but not apply them. codify plan is mainly used to check that the correct plan is generated from a config.

By default, plan operates in stateless mode, which means resources will only show up in the plan as create and modify but not destroy. Existing packages do not need to be imported into Codify in stateless mode and no state files are generated. This makes Codify easy to integrate into existing setups.

Options

Path: —path -p
Specify the path for the codify.json file. This parameter accepts both relative and absolute paths.

Output mode: —output -o
Specify the CLI output mode. Options: [default, plain, debug, json]. The output mode controls what gets printed to the console.

Debug output mode: —debug
A flag to enable debug mode. In debug mode, the debug output will be turned on and the DEBUG=codify flag will be passed to all plugins. Additional and verbose logging will be printed. Useful for debugging any issues.

Secure mode: —secure -s
Activates secure mode which sandboxes all plugins and prevents them from using sudo unless explictly permitted by the user. This is done by launching the plugins as a separate processes without TTY access. Secure mode is automatically turned on if an unverified plugin is used.

Examples

terminal
codify plan
codify plan -p ~/Downloads --output plain -s
codify plan --debug