Cheatsheet

Common ConfigSync v2 workflows. Click any command to copy it.

First-time setup on a new machine

Install the CLI, log in, and your X25519 keypair and default profile are created automatically.

Install the CLI

$npm install -g @inventivehq/configsync

Log in (creates keypair + default profile on first run)

$configsync login --token <your-token>

Track a project

Register a git repository as a project entity. The CLI detects the remote URL and branch automatically.

Add the project

$configsync project add ~/git/my-app

Push to cloud

$configsync push

Restore a project on another machine

Pull a single project by slug. The CLI clones the repo and restores associated env files.

$configsync pull --project my-app

Restore an entire workspace

Pull all projects in a workspace at once. Each member project is materialized on the local machine.

$configsync pull --project alert24

Or pull each project in a workspace (workspace slug expands to its member projects)

$configsync workspace show alert24

Set environment variables

Store structured, encrypted environment variables scoped to a project and tier.

Set a single variable

$configsync vars set API_KEY=sk-xxx --project my-app --env dev

Bulk-import from a .env file

$configsync vars push --from-file .env --project my-app --env dev

Render a composed .env to stdout

$configsync vars render --project my-app --env dev

Daily sync

Bidirectional sync: pull remote changes, push local changes, with per-entity 3-way conflict detection.

Preview what would happen

$configsync sync --dry-run

Sync both directions

$configsync sync

Create a profile for a client

Profiles bundle workspaces, modules, and packages into a named context you can activate on any machine.

$configsync profile add acme --description "Acme Corp work"

Add workspaces to a profile

Attach an existing workspace to a profile so it activates together with the rest of the context.

$configsync profile add-workspace acme alert24

Add tools to a profile

Declare machine-wide packages inside a profile. On activation, the CLI reconciles against what is installed.

$configsync profile add-package acme postgresql

Switch profiles

Activate a profile on this machine. The declared packages, workspaces, and modules become current.

$configsync profile activate acme

View history and rollback

Every entity has a version chain. Inspect past versions and roll back without losing history.

View project version history

$configsync history --project my-app

Roll back to version 3 (pushes as a new version)

$configsync rollback --project my-app --version 3

Inspect your setup

Read-only commands to see what is tracked, what is synced, and whether anything looks wrong.

$configsync status
$configsync list
$configsync doctor