Loading

codex sync plan cli command

Auth required Scope: global
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> string required

Path to the codex.yml configuration file.

Constraints: symbolic links not allowed, must exist, extensions: yml, yaml

--s3-bucket-name string required
S3 bucket to deploy to.
--out string

Path to write the plan file. Defaults to stdout.

Constraints: symbolic links not allowed

--delete-threshold number
Abort if the plan would delete more than this percentage of objects (0–100).
--exclude string[]

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 --exclude multiple times to supply more than one value

-l --log-level enum

Minimum log level.

Values: trace, debug, information, warning, error, critical, none

Default: information

-c --config-source enum

Override the configuration source: local, remote

Values: local, remote, embedded

--[no-]skip-private-repositories
Skip cloning private repositories
-l --log-level enum

Minimum log level.

Values: trace, debug, information, warning, error, critical, none

Default: information

-c --config-source enum

Override the configuration source: local, remote

Values: local, remote, embedded

--[no-]skip-private-repositories

Skip cloning private repositories