CLICommand referencecontext

context

Commands, arguments, and options for synq context.

See the workflow guide for examples. Global flags such as --json go before the command; see global options.

synq context

Manage connection contexts (list/use/add/rm)

synq context|ctx [options] [command]
SubcommandPurpose
list|lsList configured contexts
use <name>Switch the active context
add [options] <name>Create or update a context's endpoints/token
rm|remove <name>Remove a context (cannot remove the active one)

synq context add

Create or update a context's endpoints/token

synq context add [options] <name>
ArgumentMeaning
nameContext name
OptionMeaning
--api-url <url>API base URL
--dashboard-url <url>Dashboard base URL
--token <token>Personal Access Token to store
--useSwitch to this context after adding

synq context list

List configured contexts

synq context list|ls [options]

synq context rm

Remove a context (cannot remove the active one)

synq context rm|remove [options] <name>
ArgumentMeaning
nameContext name

synq context use

Switch the active context

synq context use [options] <name>
ArgumentMeaning
nameContext name

On this page