Skip to content

canvas sync course

canvas sync course

Sync entire course between instances

Synopsis

Synchronize an entire course structure including assignments, files, and settings.

The source and target can be on different Canvas instances.

Examples:

# Sync course from production to staging
canvas sync course prod 12345 staging 67890

# Sync with interactive conflict resolution
canvas sync course prod 12345 staging 67890 --interactive
canvas sync course <source-instance> <source-course-id> <target-instance> <target-course-id> [flags]

Options

  -h, --help   help for course

Options inherited from parent commands

      --as-user int       Masquerade as another user (admin feature, requires permission)
      --columns strings   Select specific columns to display (comma-separated)
      --config string     config file (default is $HOME/.canvas-cli/config.yaml)
      --dry-run           Print curl commands instead of executing requests
      --filter string     Filter results by text (case-insensitive substring match)
      --instance string   Canvas instance URL (overrides config)
  -i, --interactive       Enable interactive conflict resolution
      --limit int         Limit number of results for list operations (0 = unlimited)
      --no-cache          Disable caching of API responses
  -o, --output string     Output format: table, json, yaml, csv (default "table")
      --show-token        Show actual token in dry-run output (default: redacted)
      --sort string       Sort results by field (prefix with - for descending, e.g., -name)
  -v, --verbose           Enable verbose output

SEE ALSO

  • canvas sync - Synchronize resources between Canvas instances
Auto generated by spf13/cobra on 25-Jan-2026