For AI agents: a documentation index is available at /llms.txt
Skip to main content

Profile commands

profile upload

Capture local auth state and create a new cloud profile. Fails if the name already exists.

Command: browserless profile upload [flags]

Flags

  • --browser <key> Which local browser to capture from (e.g. chrome, edge, brave). Case-insensitive.
  • --profile <name> The browser profile to capture (e.g. Default, Personal, Profile 1).
  • --name <name> Name for the new cloud profile.
  • --exclude-domain <domain> Append a domain to the exclusion list for this run (repeatable, suffix-match).
  • --no-default-excludes Skip the persistent exclusion list for this run.
  • --only-domain <domain> Allowlist: capture only domains matching this pattern (repeatable, applies after --exclude-domain).
  • --auto-fit Drop the heaviest origins (largest first) until the artifact fits under the 2 MB server cap. Cookies are never dropped.
  • --keep-domain <domain> Protect a domain from --auto-fit drops (repeatable, suffix-match).
  • --accept-terms Pre-accept the liability disclaimer (useful in CI/scripts).
  • --password-store <type> Linux only: pass basic / gnome-libsecret / kwallet5 to the launched browser if auto-detection picks wrong.

Examples

Basic upload from Chrome's default profile

browserless profile upload \
--browser chrome --profile Default --name my-chrome

Upload with domain filtering

browserless profile upload \
--browser chrome --profile Default --name demo \
--exclude-domain chase.com --exclude-domain "*.okta.com"

Upload with auto-fit and protected domains

browserless profile upload \
--browser chrome --profile Default --name demo \
--auto-fit --keep-domain google.com --keep-domain github.com

Upload capturing only specific sites

browserless profile upload \
--browser chrome --profile Default --name demo \
--only-domain github.com --only-domain "*.atlassian.net"

profile refresh

Capture local auth state and overwrite an existing cloud profile. Fails if the name doesn't exist.

Command: browserless profile refresh [flags]

Accepts all the same flags as profile upload.

Examples

Refresh an existing profile

browserless profile refresh \
--browser chrome --profile Default --name my-chrome

profile inspect

Capture and print a summary without uploading. Useful for debugging what the CLI would send.

Command: browserless profile inspect [flags]

Accepts all the same capture flags as profile upload.

Examples

browserless profile inspect --browser chrome --profile Default

profile launch

Launch your real browser interactively against the local profile. Useful for fixing auth state (logging in, dismissing dialogs) before re-running profile refresh. The source browser must be closed first.

Command: browserless profile launch [flags]

Flags

  • --browser <key> Which local browser to launch.
  • --profile <name> The browser profile to open.
  • --headless Launch headless instead of visible (useful for scripted checks).

Examples

browserless profile launch --browser chrome --profile Default

profile list

List all cloud profiles for the current token.

Command: browserless profile list [flags]

Flags

  • --limit <n> Maximum number of profiles to return.
  • --offset <n> Number of profiles to skip (for pagination).

Examples

browserless profile list
browserless profile list --limit 5 --offset 10

profile show

Print metadata for a cloud profile: creation date, last-refreshed timestamp, origin count, and artifact size.

Command: browserless profile show <name>

Examples

browserless profile show my-chrome

profile rename

Change the name of a cloud profile without re-uploading. Any connection URLs referencing the old name stop working immediately.

Command: browserless profile rename <old-name> <new-name>

Examples

browserless profile rename my-chrome production-chrome

profile delete

Permanently remove a cloud profile and its stored auth state. This is irreversible.

Command: browserless profile delete <name>

Examples

browserless profile delete old-profile