context

Contexts are named connection profiles stored in $XDG_CONFIG_HOME/ferriskey/config.toml. Each holds a server URL, a client ID, an optional client secret, and an optional default realm. The first context you add becomes the active one.

ferris-ctl context <subcommand>

context add

Add a new context. The first context added is marked active.

ferris-ctl context add <name> --url <url> --client-id <id> [--client-secret <secret>] [--realm <realm>]
ArgumentRequiredDescription
<name>yesUnique context name
--urlyesFerrisKey server URL
--client-idyesOAuth2 client identifier
--client-secretnoClient secret (omit for public clients)
--realmnoDefault realm for this context
ferris-ctl context add staging \
  --url https://auth.staging.example.com \
  --client-id ferris-ctl \
  --realm master

context list

List all configured contexts. The active context is marked with *.

ferris-ctl context list

Table columns: active marker, name, URL, client ID, realm.

context current

Show the active context’s full configuration.

ferris-ctl context current

context use

Switch the active context.

ferris-ctl context use <name>
ArgumentRequiredDescription
<name>yesContext to activate

context remove

Remove a stored context. If it was active, the active marker is cleared.

ferris-ctl context remove <name>
ArgumentRequiredDescription
<name>yesContext to remove

context path

Print the path to the configuration file.

ferris-ctl context path