CLICommand referenceconfig

config

Commands, arguments, and options for openship config.

See the workflow guide for examples. Global flags such as --json go before the command; see global options.

openship config

Author and validate openship.json (declarative deploy config)

openship config [options] [command]
SubcommandPurpose
init [options]Scaffold an openship.json in the current directory
validate [file]Validate an openship.json against the deploy schema

openship config init

Scaffold an openship.json in the current directory

openship config init [options]
OptionMeaning
--dir <path>Directory to write into (default: ".")
--forceOverwrite an existing openship.json

openship config validate

Validate an openship.json against the deploy schema

openship config validate [options] [file]
ArgumentMeaning
filePath to the config file (default: "openship.json")

On this page