Documentation menu

CLI reference

A concise command map for installation, setup, synchronization, inspection, and recovery.

Commands use the default config at~/.config/codefoldersync/folders/default.json unless--config <path> is supplied.

Install and activate

codefoldersync installInstall the current built version.
codefoldersync upgradeInstall and activate another built version.
codefoldersync rollback --version <version>Activate a retained version.

Setup

codefoldersync setupRun the interactive create or join wizard.
codefoldersync setup --mode create ...Create a folder through automation flags.
codefoldersync setup --mode join ...Join an empty destination by folder ID.

Sync and inspect

codefoldersync doctorValidate configuration and hub reachability.
codefoldersync statusRead cursor, outbox, and conflict state.
codefoldersync syncRun one foreground synchronization.
codefoldersync daemonRun the persistent foreground daemon.
codefoldersync verify --fullForce-hash and verify the complete folder.
codefoldersync history [repository]Read causal event and result history.

Service

Terminal
codefoldersync service install
codefoldersync service start
codefoldersync service restart
codefoldersync service stop
codefoldersync service status
codefoldersync service logs
codefoldersync service uninstall

Folder contract

codefoldersync repository add <name>Enroll a direct-child repository.
codefoldersync repository remove <name>Remove membership without deleting files.
codefoldersync repository refreshRefresh the explicit membership contract.
codefoldersync ignore pushPublish the local .codefoldersyncignore contract.
codefoldersync ignore pullInstall the hub ignore contract locally.

Conflict and recovery

codefoldersync conflictsList ordinary and Git conflicts.
codefoldersync resolve-git <id> --take canonicalSelect the canonical Git state.
codefoldersync resolve-git <id> --take conflictSelect the competing Git state.
codefoldersync recover <id> --to <empty-path>Export retained content without changing the folder.
codefoldersync gc --dry-runReport reachability; never delete automatically.
codefoldersync migrate-v1 --dry-run --root <path>Inventory a V1 tree without mutation.