CLI Reference

Based Page works as a standalone CLI tool. No MCP client, no configuration file - just run npx based-page and go.

Quick Start

# Deploy a file
npx based-page deploy --file index.html --slug my-site

# Deploy inline HTML
npx based-page deploy --html '<h1>Hello</h1>' --slug hello

# List all deployments
npx based-page list

# Tear down a deployment
npx based-page teardown --id <id>

Commands

Command	Description
deploy	Deploy HTML or a file to a live URL
update	Update an existing deployment
list	List all active deployments
status	Get status and details for a single deployment
teardown	Delete a deployment permanently
login	Sign in via browser-based email verification
logout	Sign out and clear stored credentials
whoami	Show the currently authenticated user
help	Show help for any command

Authentication

The CLI auto-provisions an agent identity on first deploy - no login required. Deploys just work.

To tie deployments to a permanent account, run:

npx based-page login

Agent deploys made before login are automatically claimed into your account.

For CI/CD, set the BASED_PAGE_API_KEY environment variable instead:

export BASED_PAGE_API_KEY=bp_your_api_key_here
npx based-page deploy --file dist/index.html --slug my-app

Help

npx based-page help
npx based-page help deploy
npx based-page help update