Skip to main content
Two commands handle CLI setup and account visibility: config manages your API key and other settings, and status shows your current subscription plan, access level, and remaining query quota. Most users authenticate once via edgefinder login and never need to touch config directly, but it’s useful when you already have an API key or need to manage credentials in a CI environment.

edgefinder config

Syntax

Subcommands

config set

Saves a configuration value to ~/.edgefinder/config.json.
path.key
string
required
The configuration key to set. Valid values:
  • api-key — your EdgeFinder API key (must start with ef_live_)
  • base-url — override the default API endpoint (advanced use only)
path.value
string
required
The value to assign to the configuration key.

config show

Prints the current configuration without exposing your full API key.

Examples

Config file

Your settings are stored at ~/.edgefinder/config.json with permissions 0600 (readable only by your user). Do not commit this file to version control.

Environment variable override

Set EDGEFINDER_API_KEY to override the config file value. The environment variable always takes precedence.
Use the environment variable in CI pipelines and Docker containers to avoid writing credentials to disk:
API keys must start with ef_live_. Attempting to save a key that does not match this prefix will produce an error and exit without writing to the config file.

edgefinder status

The status command shows your account information, subscription plan, access level, and trial details if applicable.

Syntax

Options

query.--json
boolean
Output the full status payload as raw JSON instead of formatted text.

Examples

Sample output

With an active trial:
With --json:

Subscription plans

EdgeFinder offers three plans. Run edgefinder status to see which plan your API key is on.
Get your API key from chat.edgefinder.io/settings/integrations. If you use edgefinder login, your key is saved automatically and you do not need to run config set manually.