dots connections and dots sync

Every dots connections and dots sync subcommand — 21 commands with their arguments and options, read from the CLI command tree.

The dots connections and dots sync families, command by command. Every signature, argument, and option below is read from the CLI's own command tree, so this page cannot drift from dots --help. Every other family is listed in CLI Reference.

dots connections

BASH

dots connections [options] [command]

Manage importer connections (authorized external-account references).

dots connections add

BASH

dots connections add [options]

Add (or refresh) a connection for an authorized external account.

Options:

--provider <provider> — Provider id naming which connector handles the account (required).
--account <ref> — Connected-account reference the connector resolves a client from (required).
--scopes <csv> — Comma-separated OAuth/scope grants for the connection.
--credential <json> — Connected-account reference JSON '{"connectedAccountId":"…","authConfigId":"…","gatewaySource":"personal|deployment"}' the gateway proxies through; the server proves it belongs to the active gateway entity before storing it.

dots connections connect

BASH

dots connections connect [options] <provider>

Start the OAuth connect flow for a provider; prints the consent URL to open. After authorizing, run connections complete.

Arguments:

<provider> — Provider id naming which connector to connect (required).

dots connections complete

BASH

dots connections complete [options]

Complete a started connection after authorizing; persists the connection (the connected-account reference, never a token).

Options:

--provider <provider> — Provider id the connection was started for (required).
--request-id <id> — Connection request id printed by connections connect (required).

dots connections list

BASH

dots connections list [options]

List the workspace's importer connections (newest first).

Options:

--limit <n> — Maximum records to return.
--offset <n> — Records to skip before returning the page.
--count — Print the number of records this list returns instead of the records themselves.

dots connections get

BASH

dots connections get [options] <id>

Read one importer connection by id. Composed over the workspace list — the substrate registers no by-id read route.

Arguments:

<id> — Connection id (UUID) to read (required).

dots connections gateway-status

BASH

dots connections gateway-status [options]

Read whether the connector gateway is configured on this deployment, which key it resolved from, and the provider roster the connect flow can reach.

dots connections revoke

BASH

dots connections revoke [options]

Revoke a connection by id.

Options:

--id <uuid> — Connection id (UUID) to revoke (required).
--yes — Confirm the destructive action (required; it cannot be undone).
--dry-run — Resolve and report what would change; writes nothing.

dots sync

BASH

dots sync [options] [command]

Bind importer source resources to target Dotabases and run/pause syncs.

dots sync bind

BASH

dots sync bind [options]

Create a sync binding: a connector source resource, a local markdown folder (--local-dir), or a local git repo (--local-repo), bound to a target and synced by the local daemon.

Options:

--local-dir <path> — Bind a LOCAL markdown folder (path) → a (--dotabase). Watched + re-ingested by the local daemon.
--local-repo <path> — Bind a LOCAL git repo (path) → the code-graph Dotabases. Watched + re-ingested by the local daemon.
--dotabase <slug> — Target Dotabase slug for a --local-dir bind (required for --local-dir, rejected for --local-repo).
--no-watch — Real-time daemon tail on file change (local binds; defaults ON, --no-watch opts out).
--watch — Real-time daemon tail on file change (local binds; defaults ON, --no-watch opts out).
--connection <uuid> — Connection id (UUID) the binding imports through (connector bind).
--resource-kind <k> — Source-resource kind label (e.g. database, page) (connector bind).
--resource-id <id> — Source-resource id on the external platform (connector bind).
--resource-name <name> — Source-resource display name (connector bind).
--target <dotabaseUuid> — Target Dotabase id (UUID) to import into. Omitted → resolved per schema strategy.
--mode <m> — Sync mode: import_once | sync_pull | sync_bidirectional.
--schema-strategy <s> — Schema strategy: mirror_new | map_existing.
--field-map <source=target> — Map a source field to a target property key as source=target; repeatable.
--conflict-policy <policy> — Conflict policy: source_wins | target_wins | newest_wins | manual.
--cadence <c> — Sync cadence: manual | hourly | daily | weekly. Local binds default to daily.
--exclude <glob> — Glob (repeatable) the daemon sweep + tail skip, by relative path / basename (--local-dir only; e.g. --exclude "-agent-.md").
--set <pair> — Property to stamp on every synced row as key=value (repeatable; --local-dir only); the type is resolved from the Dotabase schema (e.g. --set artifact_type=plan).
--normalizer <key> — Markdown normalizer key the daemon sweep resolves for this bind (--local-dir only; e.g. field_map, inline_block, auto). Overrides the Dotabase default.
--normalizer-config <path> — Path to a JSON file with the normalizer's declarative config (MappingConfig / AutoConfig) for this bind (--local-dir only).
--defer-enrichment — Defer the heavy on-create enrichment (embedding, classification, AI fill, and tag inference) to a background drain instead of the import request, so this binding's sweeps land rows fast (--local-dir only).

dots sync list

BASH

dots sync list [options]

List the workspace's sync bindings (newest first).

Options:

--limit <n> — Maximum records to return.
--offset <n> — Records to skip before returning the page.
--count — Print the number of records this list returns instead of the records themselves.

dots sync get

BASH

dots sync get [options]

Read one sync binding's record by id — the binding alone, without the enrichment block sync status merges in.

Options:

--id <uuid> — Sync binding id (UUID) (required).

dots sync enrichment

BASH

dots sync enrichment [options]

Read one binding's deferred-enrichment drain progress by id. Unlike sync status, a route error surfaces rather than being swallowed.

Options:

--id <uuid> — Sync binding id (UUID) (required).

dots sync status

BASH

dots sync status [options]

Show a sync binding's status / detail by id.

Options:

--id <uuid> — Sync binding id (UUID) (required).

dots sync pause

BASH

dots sync pause [options]

Pause a sync binding by id.

Options:

--id <uuid> — Sync binding id (UUID) to pause (required).

dots sync update

BASH

dots sync update [options]

Change a connector binding's destination before its first import. For a local or started binding, create a new binding so one provenance identity never spans Dotabases.

Options:

--id <uuid> — Sync binding id (UUID) to update (required).
--target <dotabaseUuid> — Target Dotabase id (UUID) to import into (required).

dots sync resume

BASH

dots sync resume [options]

Return a paused sync binding to active by id. Idempotent — resuming an already-active binding succeeds and changes nothing.

Options:

--id <uuid> — Sync binding id (UUID) to resume (required).

dots sync unbind

BASH

dots sync unbind [options]

Delete a sync binding by id. The rows it already imported stay in the target Dotabase; only the binding goes.

Options:

--yes — Confirm the destructive action (required; it cannot be undone).
--dry-run — Resolve and report what would change; writes nothing.
--id <uuid> — Sync binding id (UUID) to delete (required).

dots sync run

BASH

dots sync run [options]

Start a sync binding now by id (a first run backfills; later runs pull incrementally). Runs in the background and returns immediately — poll sync status --id <id> for progress.

Options:

--id <uuid> — Sync binding id (UUID) to run (required).

dots sync sweep

BASH

dots sync sweep [options]

Reconcile ONE local markdown-folder binding once: import new/changed files into its bound Dotabase, then exit — printing created / updated / skipped / failed-file / failed-binding counts. Any failure exits unsuccessfully. The canonical per-binding one-shot (no real-time watch).

Options:

--id <uuid> — Sync binding id (UUID) to sweep (required).

dots sync watch

BASH

dots sync watch [options]

Watch every active local markdown-folder binding and re-ingest new/changed files into its bound Dotabase. Runs in the foreground until interrupted (Ctrl-C). Diagnostics go to stderr; stdout stays empty. For a single one-shot reconcile, use sync sweep --id <uuid>.

Options:

--binding <uuid> — Limit to a single binding by id (UUID); default watches all active local-folder bindings.

generator: apps/docs/pipeline/generate-reference.ts — regenerate with pnpm --filter @dots/docs docs:generate:reference; a hand edit to this page fails the docs drift gate.

dots connections and dots sync · This page in the graph

mentionstoDotabase
mentionstoDOT
referencestoCLI Reference
mentionsfromQuickstart
mentionsfromCLI Reference
referencesfromCLI Overview
documented byfromCLI Connections and Sync Management

Connected Records7

Documented by

Mentions

DOT

References

7 connections.