---
title: codex sync plan cli command
description: Compute a diff of what would change when deploying to S3 and write it to a plan file. 
url: https://docs-v3-preview.elastic.dev/docs-builder/cli/codex/sync/plan
products:
  - Elastic Docs Builder
---

# codex sync plan cli command
<cli-modifiers>
</cli-modifiers>

```bash
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.

## Arguments

<definitions>
  <definition term="<config> string required">
    Path to the codex.yml configuration file.
    **Constraints:** symbolic links not allowed, must exist, extensions: yml, yaml
  </definition>
</definitions>


## Options

<definitions>
  <definition term="--s3-bucket-name string required">
    S3 bucket to deploy to.
  </definition>
  <definition term="--out string">
    Path to write the plan file. Defaults to stdout.
    **Constraints:** symbolic links not allowed
  </definition>
  <definition term="--delete-threshold number">
    Abort if the plan would delete more than this percentage of objects (0–100).
  </definition>
  <definition term="--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
  </definition>
  <definition term="-l --log-level enum">
    Minimum log level.
    **Values:** trace, debug, information, warning, error, critical, none
    **Default:** `information`
  </definition>
  <definition term="-c --config-source enum">
    Override the configuration source: local, remote
    **Values:** local, remote, embedded
  </definition>
  <definition term="--[no-]skip-private-repositories">
    Skip cloning private repositories
  </definition>
</definitions>


## Global Options

<definitions>
  <definition term="-l --log-level enum">
    Minimum log level.
    **Values:** trace, debug, information, warning, error, critical, none
    **Default:** `information`
  </definition>
  <definition term="-c --config-source enum">
    Override the configuration source: local, remote
    **Values:** local, remote, embedded
  </definition>
  <definition term="--[no-]skip-private-repositories">
    Skip cloning private repositories
  </definition>
</definitions>