PrompteryxBeta
    ⌘K
    PlatformSupport
    Menu
    IntroductionInstall Desktop & extensionQuick StartPlatform Overview
    OverviewWhat you can makeAI Browser Agent in the chatModels and AutoConnectorsSchedulesProjectsExplore and publishingShare linksMemory and SkillsPersonal agent (beta)Welcome, settings and skinsPlans, credits and top-upsPrompteryx DesktopGroups (pilot)Phone app (early access)
    OverviewCreating WorkflowsTesting & DebuggingScheduling
    OverviewGetting StartedCommandsRecordingSettingsStructured OutputParallel AgentsTips & Best Practices
    OverviewInstallationSidebar AgentUsing Attached FilesExecute on Current TabExporting to Visual Studio
    Overview
    OverviewOpen PageClickClick CoordinatesFillExtract TextScreenshotWaitPress KeyFocus ElementBlur ElementSelect TextHighlight ElementSet ViewportGet Bounding BoxScrollHoverSelect OptionAssertionsCookiesEvaluate JavaScriptExample Workflows
    OverviewPrompteryx Browser AgentOpenAI
    OverviewSchedule TriggerWebhook Trigger
    OverviewGoogle SheetsGoogle CalendarConnect Hub (3,000+ apps)Example Workflows
    AI Vision SettingsChrome Automation ProfilesCloud BrowserBrowser Profiles & Persistent ContextVideo RecordingExecution LogsSharing & CollaborationEdit History
    Selectors GuideVariables
    Start hereGet an API keyRun the AI browser agentDrive a cloud browserRun workflows from anywhereUse connected apps (Connect Hub)SDK (TypeScript)CLIMCP for AI assistants
    REST APIWebhooksMCP toolsCloud Browser APICloud Browser quickstartMigrate from Browserbasen8nZapierMake.com

    Need help? Contact Support

    1. Documentation
    3. Developers
    5. Cli

    CLI

    Prompteryx from a terminal or a CI job. Sign in once in the browser; tokens refresh on their own.

    Install and sign in
    npm install -g prompteryx        # or use npx prompteryx … without installing
prompteryx login                 # opens the browser, you click Approve, done
prompteryx whoami
    Servers and CI: use a key instead
    prompteryx login --key px_live_YOUR_KEY
# or set PROMPTERYX_API_KEY in the environment and skip login entirely
    Commands
    Add --json to any command for machine-readable output.
    agent "goal" [--start-url URL] [--model ID] [--max-steps N] [--max-credits N] [--save-as-workflow] [--local]
workflows list [--search q] | get <id> | run <id> [--input key=value …] [--wait] [--visible] [--webhook-url URL]
runs get <id> | wait <id> | logs <id>
browser create [--record] [--local] | list | close <id>
schedules list [--workflow <id>]
apps list [--search q] | actions <app> | accounts | run <app> <action> --params '{…}' [--account <id>]
mcp <claude-code|cursor|vscode|claude-desktop|http>
login | whoami | logout | help | version

    Examples

    Run an agent and keep the result as a workflow
    prompteryx agent "Download this month's invoice from my supplier portal" --save-as-workflow
# Saved as workflow wf_… Run it again with: prompteryx workflows run wf_…
    Run a workflow with variables and wait
    prompteryx workflows run fHX8NlpAJxoWuAOll7zr --input postcode="SW1A 1AA" --wait
    Start a cloud browser for Playwright
    prompteryx login --cloud-browser-key pcb_live_YOUR_KEY
prompteryx browser create --record
prompteryx browser close pcb_…
    Send an email through a connected account
    prompteryx apps run gmail gmail-send-email --params '{"to":"hello@example.com","subject":"Hi","body":"From the CLI"}'
    Set up an AI assistant in one line
    prompteryx mcp claude-code     # prints the claude mcp add … command
prompteryx mcp cursor          # prints the one-click install link
    Where things live

    Credentials are saved in ~/.prompteryx/config.json with owner-only permissions. prompteryx logout revokes the OAuth tokens and removes the saved keys.

    PROMPTERYX_API_KEY, PROMPTERYX_CLOUD_BROWSER_KEY and PROMPTERYX_API_URL override the saved config, which is what CI should use.

    Access follows your balance of cloud minutes and AI credits on any plan. The same limits and errors as the SDK, which the CLI wraps.

    Use version 0.2.0 or later (prompteryx version). It needs SDK 0.5.0, and fixes workflows run --wait and workflows list --search. whoami now shows your remaining credits, minutes and calls.