codex sync plan cli command
docs-builder codex sync plan <config> --s3-bucket-name <string> [options]
Compute a diff of what would change when deploying to S3 and write it to a plan file.
<config>stringrequired-
Path to the codex.yml configuration file.
Constraints: symbolic links not allowed, must exist, extensions: yml, yaml
--s3-bucket-namestringrequired- S3 bucket to deploy to.
--outstring-
Path to write the plan file. Defaults to stdout.
Constraints: symbolic links not allowed
--delete-thresholdnumber- Abort if the plan would delete more than this percentage of objects (0–100).
--excludestring[]-
Glob patterns to exclude from both upload and deletion (repeatable). For example: --exclude '_preview/' --exclude '403/'. Matched against the S3 key / relative path of each object.
Repeatable: pass
--excludemultiple times to supply more than one value -l--log-levelenum-
Minimum log level.
Values: trace, debug, information, warning, error, critical, none
Default:
information -c--config-sourceenum-
Override the configuration source: local, remote
Values: local, remote, embedded
--[no-]skip-private-repositories- Skip cloning private repositories
-l--log-levelenum-
Minimum log level.
Values: trace, debug, information, warning, error, critical, none
Default:
information -c--config-sourceenum-
Override the configuration source: local, remote
Values: local, remote, embedded
--[no-]skip-private-repositories-
Skip cloning private repositories