> ## Documentation Index
> Fetch the complete documentation index at: https://edgefinder.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# edgefinder config and status — CLI setup and account info

> Configure your EdgeFinder API key and check your subscription plan, account access, and query usage with edgefinder config and edgefinder status.

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

```bash theme={null}
edgefinder config set <key> <value>
edgefinder config show
```

### Subcommands

#### config set

Saves a configuration value to `~/.edgefinder/config.json`.

<ParamField path="path.key" type="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)
</ParamField>

<ParamField path="path.value" type="string" required>
  The value to assign to the configuration key.
</ParamField>

#### config show

Prints the current configuration without exposing your full API key.

```bash theme={null}
edgefinder config show
```

```text theme={null}
API Key:     ef_live_abc123... (truncated)
Base URL:    https://chat.edgefinder.io
Config file: /home/yourname/.edgefinder/config.json
```

### Examples

<CodeGroup>
  ```bash Save API key theme={null}
  edgefinder config set api-key ef_live_abc123def456ghi789
  ```

  ```bash View current config theme={null}
  edgefinder config show
  ```
</CodeGroup>

### 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.

```json theme={null}
{
  "apiKey": "ef_live_abc123def456ghi789"
}
```

### Environment variable override

Set `EDGEFINDER_API_KEY` to override the config file value. The environment variable always takes precedence.

```bash theme={null}
export EDGEFINDER_API_KEY=ef_live_abc123def456ghi789
edgefinder ask "Best NFL picks this week"
```

<Tip>
  Use the environment variable in CI pipelines and Docker containers to avoid writing credentials to disk:

  ```bash theme={null}
  EDGEFINDER_API_KEY=ef_live_... edgefinder status
  ```
</Tip>

<Warning>
  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.
</Warning>

***

## edgefinder status

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

### Syntax

```bash theme={null}
edgefinder status [--json]
```

### Options

<ParamField path="query.--json" type="boolean">
  Output the full status payload as raw JSON instead of formatted text.
</ParamField>

### Examples

<CodeGroup>
  ```bash Formatted output theme={null}
  edgefinder status
  ```

  ```bash JSON output theme={null}
  edgefinder status --json
  ```
</CodeGroup>

### Sample output

```text theme={null}
Plan:           Pro
Status:         active
Access:         Yes (active subscription)
Unlimited:      No
```

With an active trial:

```text theme={null}
Plan:           Starter
Status:         trialing
Access:         Yes (trial)
Unlimited:      No
Trial:          12 days remaining
Trial ends:     5/3/2026
```

With `--json`:

```json theme={null}
{
  "subscriptionPlan": "Pro",
  "subscriptionStatus": "active",
  "hasUnlimitedAccess": false,
  "hasAccess": true,
  "reason": "active subscription",
  "trialEndsAt": null,
  "trialDaysLeft": null,
  "isTrialing": false
}
```

### Subscription plans

EdgeFinder offers three plans. Run `edgefinder status` to see which plan your API key is on.

| Plan     | Price       |
| -------- | ----------- |
| Starter  | \$20/month  |
| Pro      | \$50/month  |
| Ultimate | \$150/month |

<Note>
  Get your API key from [chat.edgefinder.io/settings/integrations](https://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.
</Note>