CLI authentication

Use a console API key from the API Keys page, then log in with the CLI.

Create a key

Open API Keys in the Proceeds dashboard.
Create a key with the scopes you need (services, paywalls, transactions, events).
Copy the mpk_… value — it is shown only once.

Log in

proceeds auth login
proceeds auth status --format json

Example response (auth status):

{
  "data": {
    "authenticated": true,
    "profile": "default",
    "apiUrl": "https://api.myproceeds.xyz",
    "source": "profile",
    "user": {
      "id": "cmp…",
      "email": "you@example.com",
      "walletAddress": "0x…"
    },
    "apiKey": {
      "name": "CLI",
      "scopes": ["services:write", "paywalls:write", "transactions:read", "events:read"],
      "keyPrefix": "mpk_…"
    }
  }
}

Profiles

A profile stores an API key and API origin under a name. The first login creates the default profile. Create more profiles when you need another key, a different API origin, or a separate workspace.

proceeds auth login --profile staging
proceeds auth profiles --format json
proceeds auth switch default --format json
proceeds auth logout

Flags

Optional flags on auth (and most other) commands:

Flag	Environment variable	Description
`--profile <string>`	`PROCEEDS_PROFILE`	Named profile to create or use
`--api-url <string>`	`PROCEEDS_BASE_URL`	API origin; defaults to `https://api.myproceeds.xyz`

# Create or update a named profile
proceeds auth login --profile staging

# Point a profile at a custom API origin
proceeds auth login --profile staging --api-url https://api.example.com

# Run a command against a non-active profile
proceeds services list --profile staging --format json

Example response (auth profiles):

{
  "data": {
    "activeProfile": "default",
    "profiles": [
      {
        "name": "default",
        "apiUrl": "https://api.myproceeds.xyz",
        "credentialType": "api-key",
        "active": true
      }
    ]
  }
}

Example response (auth switch):

{
  "data": {
    "activeProfile": "default"
  }
}

logout removes the local profile only — revoke the key in the console if it is compromised.

Services

Create and manage services.

Paywalls

Create and manage paywalls.

Getting Started

Guides

Manage

API Reference

CLI

Agent Wallets

CLI authentication

Create a key

Log in

Profiles

Flags

Next

Services

Paywalls

​Create a key

​Log in

​Profiles

​Flags

​Next

Services

Paywalls

Create a key

Log in

Profiles

Flags

Next