Setup

The docex setup command is the primary onboarding path. It authenticates via GitHub, provisions a prepaid wallet, and returns a scoped API key. Human approval is only required for the wallet top-up.

Command

docex setup --use-case "vision analysis for security scanning" --framework auto --top-up 5 --json

Flags

Flag	Required	Description
`--use-case`	Yes	Description of your workflow. Used for workspace labeling.
`--framework`	No	`auto`, `next`, or `node`. Defaults to `auto`.
`--top-up`	No	USD wallet recharge amount. Defaults to `5`.
`--base-url`	No	API base URL. Defaults to `http://localhost:4000`.
`--json`	No	Output machine-readable JSON instead of human text.

Flow

Agent runs setup

The agent executes docex setup --json and receives a pending setup session with an approval URL.

Human approves

The human opens the approval URL, signs in with GitHub, and approves the wallet top-up.

Agent receives credentials

The agent polls the setup session. Once approved, it receives DOCEX_API_KEY and DOCEX_BASE_URL.

Agent wires the app

The agent exports the credentials to environment variables and scaffolds the integration.

Output example

{
  "status": "approved",
  "apiKey": "dx_live_xxxxxxxxxxxx",
  "baseUrl": "https://api.docex.dev",
  "walletBalanceUsd": 5.00
}

The API key is shown once during setup. Store it immediately in environment variables or a secrets manager.

Local development

Without Stripe secrets, checkout is mocked and the setup session is approved immediately. This is useful for testing and offline development.

export DOCEX_BASE_URL="http://localhost:4000"
npx docex setup --use-case "local testing" --top-up 5 --json

Getting Started

Concepts

API Reference

SDK & CLI

Integrations

Changelog

Setup

Setup

Command

Flags

Flow

Output example

Local development

​Setup

​Command

​Flags

​Flow

​Output example

​Local development

Setup

Command

Flags

Flow

Output example

Local development