Skip to content
Cindergrid

Sync client reference

Updated 20 October 2026. Applies to scheduler 2026.11 and sync client 2.8.

cgsync is the command-line client behind every plugin. The desktop app uses the same engine. Current version: 2.8.1, released 20 October 2026.

Install

macOS 13+, Windows 10+ and Linux x86-64 and arm64 builds are signed. Packages are on the plugins page. Update with cgsync self-update.

Commands

CommandWhat it does
loginSign in using a browser confirmation code. Tokens live in the OS keychain.
scene checkDry run: lists dependencies, sizes and dedupe savings.
uploadUploads a folder or scene to a project.
submitCreates a job from a scene and a set of options.
jobsLists your jobs, with --watch for a live view.
pullDownloads frames and logs, with optional --watch.
projectsLists, archives, restores and deletes projects.
usageShows core-hours, GPU-hours, storage and downloads for this month, filterable by tag.

Configuration

Settings live in ~/.config/cindergrid/config.toml (macOS and Linux) or %APPDATA%\Cindergrid\config.toml.

[transfer]
streams       = 16          # capped by your plan
chunk_mib     = 8           # 4, 8 or 16
limit         = "0"         # 0 = unlimited
verify        = "full"      # full | sample

[defaults]
region        = "eu-north"
pull_dir      = "~/renders"
keep_logs     = true

Downloads

Frames are written to a temporary name and renamed only after the hash matches, so downstream tools never see a partial file. Multi-layer EXRs are stored byte-for-byte as the renderer wrote them. Use --flatten to also write a beauty-only sequence.

Exit codes

0Done
2Bad arguments or unsupported scene
3Authentication needed
4Plan limit reached (storage, concurrency or downloads)
5Network failure after retries; safe to run again
6Hash mismatch; the chunk was discarded and re-fetched

Environment

CGSYNC_TOKEN authenticates CI machines with a project-scoped token created in account settings. CGSYNC_GATEWAY_URL is read if your office requires an outbound HTTPS gateway. CGSYNC_LOG=debug writes a trace to the config directory; send it with any support request.