Skip to Content
SPAPS is proprietary hosted SaaS. Paid access required; pre-1.0 contracts may change. Terms and access
PackagesSPAPS CLI Quickstart

SPAPS CLI

The spaps command-line client connects to the hosted service. Use it to authenticate, inspect your identity, verify configured credentials, and call authorized control-plane commands.

Verified public release: spaps 0.11.2.

Install And Connect

Inspect the installed version

npx spaps@0.11.2 --version

Configure the hosted API

export SPAPS_API_URL=https://api.sweetpotato.dev export SPAPS_API_KEY=spaps_sec_your_staging_key export SPAPS_CLI_CLIENT_ID=your-staging-application-slug

Authenticate

npx spaps connect npx spaps whoami

Inspect connection configuration

npx spaps verify --json

Device login uses the application slug, not the application secret. Later server commands may need the secret key. verify checks service health and whether a key is configured; use whoami and a scoped API request to verify authenticated access.

Keep secret application keys in a secret manager or protected shell environment. Do not commit them, place them in browser configuration, or paste them into support messages.

Authentication Commands

CommandPurpose
spaps login / spaps connectStart device-flow authentication
spaps whoamiRead the authenticated identity
spaps tokenPrint the current short-lived access token
spaps logoutAttempt server revocation and clear local credentials
spaps verify --jsonCheck reachability and local key configuration

Login stores credentials in the OS keyring when available, with an encrypted file mirror at ~/.config/spaps/credentials.json (mode 0600). Check logout --json’s server_revoked result: local cleanup alone does not prove server revocation. spaps token prints a bearer credential; keep its output out of logs and support messages.

Authorized Control-Plane Commands

Availability depends on the capabilities granted to your application and user.

npx spaps dayrate config --json npx spaps policy list --json npx spaps webhook list --json npx spaps issue-reports list-mine --status open --json

Next