Skip to main content

Quick Start

This guide gets you from zero to a successful cloud verification in under five minutes.

Step 1 — Install

npm install -g @prokodo/cli

Step 2 — Get your API key

  1. Log in to the prokodo marketplace
  2. Go to Account → API Keys
  3. Click Create new key and copy the value — it starts with pk_live_
warning

API keys are shown only once. Store your key securely (e.g. in a password manager or a CI secret).

Step 3 — Authenticate

prokodo auth login --key pk_live_yourkeyhere

The CLI validates the key against the prokodo API and stores it at ~/.config/prokodo/credentials.json with 0600 permissions.

Confirm it was saved:

prokodo auth whoami
# → API key: ••••••••abcd

Step 4 — Initialise your project

Inside your project directory, run:

cd /path/to/my-project
prokodo init --slug my-project

This creates .prokodo/config.json:

{
  "projectSlug": "my-project",
  "verifyGlobs": ["src/**/*", "public/**/*"],
  "timeout": 300
}

Commit this file to version control — it is safe to share.

Step 5 — Verify

prokodo verify

The CLI will:

  1. Collect files matching verifyGlobs
  2. Upload them to the prokodo cloud
  3. Stream live logs while the run is in progress
  4. Print the result and exit with 0 (pass) or 1 (fail)

All done!

# Check your balance after the run
prokodo credits

# Run a full environment health-check
prokodo doctor --json | jq .

Next steps