Skip to content

Command reference

Every command in the CLI (209 in total), generated from --help and privy schema. Locally, privy cli search "your task" finds the right one.

Option Description
--app <id> App to act on. Overrides a privy.json binding and the saved selection.
--account <id> Account (workspace) for account-scoped commands.
--profile <name> Saved login profile. Otherwise PRIVY_PROFILE, the project binding, then default.
--no-project Ignore privy.json in the current directory.
--json JSON output. Already the default.
  • privy integrations coinbase get: Read safe metadata for coinbase. Coinbase Onramp own credentials. Does not enable a funding method, start onboarding, buy assets or transfer funds.
  • privy integrations coinbase update: Configure coinbase. Coinbase Onramp own credentials. Does not enable a funding method, start onboarding, buy assets or transfer funds.
  • privy integrations kraken get: Read safe metadata for kraken. Complete Kraken Embed configuration; requires explicit provider environment and credentials. No purchases or transfers.
  • privy integrations kraken update: Configure kraken. Complete Kraken Embed configuration; requires explicit provider environment and credentials. No purchases or transfers.
  • privy integrations blockaid get: Read safe metadata for blockaid. Production-app-only cross-app scanning configuration; also requires an enabled verified cookie domain or non-private ecosystem. No production conversion, billing change, domain, account approval or publishing is performed implicitly.
  • privy integrations blockaid update: Configure blockaid. Production-app-only cross-app scanning configuration; also requires an enabled verified cookie domain or non-private ecosystem. No production conversion, billing change, domain, account approval or publishing is performed implicitly.
  • privy integrations walletconnect get: Read the public WalletConnect/Reown project ID configured for this app.
  • privy integrations walletconnect update: Set or clear the WalletConnect project ID; preview/diff, environment guard and fresh read-back.
  • privy auth login: Renew and verify a saved session first; use browser/email login only for a new or explicitly replaced session.
  • privy auth status: Inspect local session expiry; optionally check remote access WITHOUT refreshing or changing credentials.
  • privy auth whoami: Verify remote access and show current identity and accounts.
  • privy auth refresh: Attempt one session renewal, persist it and verify remote dashboard access.
  • privy auth logout: Revoke this session and remove local credentials, not all user sessions.
  • privy project show: Show effective app/profile selection and directory binding without contacting Privy.
  • privy project init: Write privy.json for the selected profile/app; no remote resource is created.
  • privy secrets list: List nonsecret resource references for the selected app; no network or secret reads.
  • privy secrets status: Check whether an app resource secret is stored locally; never reveal its value.
  • privy secrets forget: Remove a local resource secret only; does not revoke it at Privy.
  • privy secrets run: Explicitly give one stored secret to a TRUSTED child through its environment; child output is not redacted.
  • privy doctor: Check runtime, browser, profile and credential-store access (no remote API requests).
  • privy schema: Describe the actual API request, inputs and behavior of a command.
  • privy cli search: Search commands locally; no credentials, network or model required.
  • privy docs read: Read one bundled Markdown guide as JSON; use docs for exact topic names.
  • privy docs search: Search bundled guide contents locally; returns up to five matches.
  • privy docs path: Locate the bundled guide directory or one exact topic file.

Privy CLI is an unofficial, community project by Samarth Saxena. Not affiliated with or endorsed by Privy. The Privy name and wordmark belong to Privy. It uses undocumented dashboard APIs that can change.