Skip to content
2 min read

Install & authenticate

Install the SEOCTL CLI on macOS, Linux, or WSL and connect it to your account key.

SEOCTL is a single, self-contained binary. There is nothing to compile and no runtime to install.

Install the CLI

The install script detects your platform and drops the seoctl binary on your PATH:

curl -fsSL https://seoctl.com/install.sh | sh

Prefer to inspect first? Read the script before running it, or download the binary for your platform directly from the GitHub releases page and verify the published checksum.

Confirm it is on your path:

seoctl version
seoctl 0.1.0 (darwin/arm64)

Get an account key

SEOCTL talks to a hosted gateway, so every request is authenticated with an account key.

  1. Sign in at seoctl.com/login with your email — no password, just a one-time code.
  2. Open the dashboard and create a key.
  3. Copy it once. Keys are shown a single time and stored hashed.

Authenticate

Hand the key to the CLI:

seoctl auth seoctl_live_example_key

seoctl auth reads the key interactively if you omit it — preferred, since a key passed as an argument lands in your shell history. The key is then written to a local config file:

~/.config/seoctl/config.json

Check the connection any time:

seoctl status
{"account":"you@company.com","credits":480,"plan":"beta","ok":true}

A healthy response reports your account and remaining credits.

Use an environment variable instead

For CI, containers, or agent sandboxes, skip the config file and pass the key as an environment variable:

export SEOCTL_API_KEY="seoctl_live_example_key"
seoctl status

The environment variable always takes precedence over the stored config.

Next

Head to the Quickstart to run your first lookups, or jump straight to the Command reference.