Connections and access

The CLI stores named contexts in ~/.synq/config.json. Each context contains an API URL, dashboard URL, and personal access token. One context is active at a time.

Log in

synq login \
  --api-url https://app.example.com \
  --dashboard-url https://app.example.com \
  --context production

The CLI opens the dashboard token page and prompts for a token. For scripts, pass --token "$SYNQ_TOKEN". Login validates the token before storing it and selects the context. The local default API is http://localhost:4000; the local dashboard default is http://localhost:3001.

Switch contexts

synq context list
synq context use production
synq status

context add stores endpoints and a token without validating them. Use login when you want validation. context rm removes an inactive context. logout clears a token while keeping its endpoints.

synq logout --context production

See the context, login, and logout references for all options.

Create a token

Choose explicit access for each token:

synq token create deploy-bot --grant project:proj_123:read,write
synq token create report-reader --read-only --expires 30 --full-access
synq token list

Pass either --grant or --full-access; omitting both is refused. A full-access token acts with your own permissions. Scoped credentials cannot mint unrestricted credentials.

Copy a new token's secret when it is created; later reads show only metadata. Revoke by token ID:

synq token revoke pat_123

See token options and permission scopes.

Call an HTTP endpoint

synq api /projects
synq api /domains --query projectId=proj_123

Paths are relative to /api. Use --method to select a method and --data for a JSON body; supplying data defaults the method to POST. Responses are printed, and non-success HTTP results exit nonzero. See raw API options and the HTTP reference.

Native mode

Contexts describe remote HTTP connections. Native mode uses an explicitly trusted configuration file to select an owned installation and identity.