Skip to the page

rykloud environment-variables

Environment variables and where configuration is kept

Configuration lives in $RYKLOUD_CONFIG_DIR, else $XDG_CONFIG_HOME/rykloud, else ~/.config/rykloud (%AppData%\rykloud on Windows): config.yaml holds contexts.

Sessions (a context's Rykloud session, and its Rykon Mail session) are kept in the system keychain (macOS Keychain, Windows Credential Manager, the Secret Service on Linux), or in credentials.json (mode 0600) in the same folder when there is no keychain.

  RYKLOUD_CONTEXT              the context to use
  RYKLOUD_ORG, RYKLOUD_PROJECT the organisation and project, by name or id
  RYKLOUD_OUTPUT               table, json or yaml
  RYKLOUD_TOKEN                an access token to use instead of a stored session (CI)
  RYKLOUD_MAIL_API             Rykon Mail's API address (rykloud mail)
  RYKLOUD_MAIL_ACCOUNT         the Rykon Mail account, by name or id
  RYKLOUD_MAIL_TOKEN           a Rykon Mail API key or service account access token,
                               used instead of the Rykon Mail session (CI)
  RYKLOUD_MAIL_SA_SECRET       a service account's secret, for
                               rykloud mail service-accounts token
  RYKLOUD_CREDENTIALS          file or keyring: force the credential store
  RYKLOUD_CONFIG_DIR           where configuration is kept
  RYKLOUD_NO_UPDATE_NOTIFIER   set to stop the notice of a newer version
  NO_COLOR                     set for no colour; FORCE_COLOR to force it

Every command also takes the global flags.