Skip to main content

ephervex api

Inspect and change provider API settings

Usage and options​

Inspect and change provider API settings

Usage: ephervex api [OPTIONS] <COMMAND>

Commands:
  show                  Show the API settings and where credentials are kept
  set-client-id         Set the Microsoft Client ID, or clear it back to this build's default
  set-user-agent        Set the advanced custom User-Agent, or clear it
  set-curseforge-key    Read a CurseForge API key from standard input and store it in the system keyring
  clear-curseforge-key  Remove the stored CurseForge API key
  help                  Print this message or the help of the given subcommand(s)

Options:
      --json  Emit machine-readable JSON where the command supports it
  -h, --help  Print help

ephervex api show​

Show the API settings and where credentials are kept

Usage: ephervex api show [OPTIONS]

Options:
      --json  Emit machine-readable JSON where the command supports it
  -h, --help  Print help

ephervex api set-client-id​

Set the Microsoft Client ID, or clear it back to this build's default

Usage: ephervex api set-client-id [OPTIONS] [CLIENT_ID]

Arguments:
  [CLIENT_ID]  The Azure application (client) ID. Omit to clear

Options:
      --json  Emit machine-readable JSON where the command supports it
  -h, --help  Print help

ephervex api set-user-agent​

Set the advanced custom User-Agent, or clear it

Usage: ephervex api set-user-agent [OPTIONS] [USER_AGENT]

Arguments:
  [USER_AGENT]

Options:
      --json  Emit machine-readable JSON where the command supports it
  -h, --help  Print help

ephervex api set-curseforge-key​

Read a CurseForge API key from standard input and store it in the system keyring.

This is a CurseForge third-party API key, which you apply for through CurseForge/Overwolf. It is not the CurseForge Upload API token. The key is stored in the system keyring and never written to Ephervex's configuration.

From stdin rather than an argument on purpose: process arguments are readable by every other process on the machine through `/proc`, and a shell would put the key in the history file too.

Usage: ephervex api set-curseforge-key [OPTIONS]

Options:
      --json
          Emit machine-readable JSON where the command supports it

  -h, --help
          Print help (see a summary with '-h')

ephervex api clear-curseforge-key​

Remove the stored CurseForge API key

Usage: ephervex api clear-curseforge-key [OPTIONS]

Options:
      --json  Emit machine-readable JSON where the command supports it
  -h, --help  Print help