CLI

Install & first weekly desk

Five steps from binary to a useful desk read. For paid PageSeeds CLI customers — deeper docs stay in the app repo.

Step 1

Install

Run the install script (source of truth). Prebuilt binary is macOS Apple Silicon only today. Other platforms: check out the repo and build with cargo — see the CLI docs.

curl -fsSL https://raw.githubusercontent.com/fstrauf/pageseeds-app/main/scripts/install-cli.sh | bash
  • Installs to ~/.local/bin/pageseeds-cli
  • Ensure PATH includes ~/.local/bin:
export PATH="$HOME/.local/bin:$PATH"

Verify:

pageseeds-cli --help

Step 2

Activate license

Your license key is on the purchase success page and in your email. Documented contract:

pageseeds-cli license activate <key>
pageseeds-cli license status

When the license gate is live: paid tools require an activated key. If activate/status is still landing in your build, use the same commands once the gate ships — do not invent alternate APIs.

Step 3

Project + env

Every desk tool needs a project id and an absolute project path:

pageseeds-cli <command> -i <project-id> -p /absolute/path/to/project

Secrets load from ~/.config/automation/secrets.env, then the project's .env.local / .env. Minimum for GSC desk work: GSC_SERVICE_ACCOUNT_PATH (or the OAuth alternative documented in the app).

Honest gap: the CLI does not create projects. Discover existing projects via the desktop app (or the app's SQLite store). See CLI getting started for details — we do not publish raw DB recipes here.

Step 4

First desk read

Run a site overview (JSON on stdout):

pageseeds-cli site-overview -i <project-id> -p /absolute/path/to/project

Other useful reads include article and GSC query desks (same -i / -p flags). Pipe or save stdout as needed.

Step 5

Weekly operator

Weekly loop sketch: run desk reads → pick ≤5 actions → follow Path B in the operator skill. Full workflow lives in the app repo — we link out rather than rehost it.

Troubleshooting
Common blockers when the CLI is quiet or errors early.
  • command not found — add ~/.local/bin to PATH and open a new shell.
  • Missing -i / -p — every desk tool requires -i <project-id> and -p <absolute path>.
  • License required — paid tools need an activated key (license activate / license status).
  • GSC not connected — set GSC_SERVICE_ACCOUNT_PATH (or OAuth) in secrets / project env before GSC desk commands.