> ## Documentation Index
> Fetch the complete documentation index at: https://wb-21fd5541-sweeps-updates.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# wandb sync

export const GitHubLink = ({url, compact = false}) => <a href={url} target="_blank" rel="noopener noreferrer" className={compact ? "source-link" : "github-source-link"}>
    {compact ? "View source" : <>
    <svg width="20" height="20" viewBox="0 0 24 24" fill="currentColor" xmlns="http://www.w3.org/2000/svg">
      <path d="M12 0C5.37 0 0 5.37 0 12c0 5.31 3.435 9.795 8.205 11.385.6.105.825-.255.825-.57 0-.285-.015-1.23-.015-2.235-3.015.555-3.795-.735-4.035-1.41-.135-.345-.72-1.41-1.23-1.695-.42-.225-1.02-.78-.015-.795.945-.015 1.62.87 1.845 1.23 1.08 1.815 2.805 1.305 3.495.99.105-.78.42-1.305.765-1.605-2.67-.3-5.46-1.335-5.46-5.925 0-1.305.465-2.385 1.23-3.225-.12-.3-.54-1.53.12-3.18 0 0 1.005-.315 3.3 1.23.96-.27 1.98-.405 3-.405s2.04.135 3 .405c2.295-1.56 3.3-1.23 3.3-1.23.66 1.65.24 2.88.12 3.18.765.84 1.23 1.905 1.23 3.225 0 4.605-2.805 5.625-5.475 5.925.435.375.81 1.095.81 2.22 0 1.605-.015 2.895-.015 3.3 0 .315.225.69.825.57A12.02 12.02 0 0024 12c0-6.63-5.37-12-12-12z" />
    </svg>
    GitHub source
      </>}
  </a>;

<GitHubLink compact url="https://github.com/wandb/wandb/blob/v0.30.0/wandb/cli/cli.py#L521" />

## Usage

```bash theme={null}
sync [OPTIONS] [PATHS]...
```

## Description

Upload existing local W\&B run data to the cloud.

Sync offline or incomplete runs to the W\&B server. Provide PATHS to sync
specific runs, or run with no arguments to sync un-uploaded runs in the
wandb folder.

When no PATHS are given, this will ask for confirmation before
syncing. Pass --yes to skip confirmation or --dry-run to exit without
syncing.

PATHS should be run directories, usually in the format

./wandb/run-YYYYMMDD\_HHMMSS-RUN\_ID

YYYYMMDD\_HHMMSS is the timestamp of when the run was created and RUN\_ID is
its unique ID.

For example, to show a summary of local runs and their sync status:

```bash theme={null}
wandb sync --dry-run
```

To sync run ID abcd1234 that is saved in ./wandb/run-20170617\_000000-abcd1234:

```bash theme={null}
wandb sync ./wandb/run-20170617_000000-abcd1234
```

To sync all unsynced runs in the wandb folder:

```bash theme={null}
wandb sync
```

Use `wandb clean` to delete local data for runs that have been synced. See

```bash theme={null}
wandb clean --help
```

for more info.

## Arguments

| Name    | Default | Type  |
| ------- | ------- | ----- |
| `paths` | PATH    | False |

## Options

| Flag                                 | Type      | Description                                                                                                                                                                                                                                                           |
| ------------------------------------ | --------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `-v, --verbose`                      | BOOL Flag | Print more information. **Default**: False                                                                                                                                                                                                                            |
| `--yes`                              | BOOL Flag | Don't prompt for confirmation. **Default**: False                                                                                                                                                                                                                     |
| `--id`                               | STR       | Upload to an existing run ID.  If this is set when syncing multiple files (with the same entity and project), the files will be synced in order of start time. **Default**: None                                                                                      |
| `--project, -p`                      | STR       | Override the project for all synced runs. **Default**: None                                                                                                                                                                                                           |
| `--entity, -e`                       | STR       | Override the entity for all synced runs. **Default**: None                                                                                                                                                                                                            |
| `--job-type`                         | STR       | Override the job type for all synced runs. **Default**: None                                                                                                                                                                                                          |
| `--include-online, --no-skip-online` | BOOL Flag | Include runs created in online mode. **Default**: None                                                                                                                                                                                                                |
| `--include-synced, --no-skip-synced` | BOOL Flag | Include runs that are already synced. **Default**: None                                                                                                                                                                                                               |
| `--replace-tags`                     | STR       | Rename tags using the format 'old1=new1,old2=new2'. **Default**: None                                                                                                                                                                                                 |
| `--dry-run`                          | BOOL Flag | Print what would happen without uploading anything. **Default**: False                                                                                                                                                                                                |
| `-n`                                 | INT       | Max number of runs to sync at a time.  When syncing multiple files that are part of the same run, the files are synced sequentially in order of start time regardless of this setting. This happens for resumed runs or when using the --id parameter. **Default**: 5 |