Skip to content

Installation

Prerequisites

Based Page requires Node.js 18+. Check your version:

bash
node --version

OpenClaw

The easiest setup. Use mcporter to install Based Page with one command:

bash
mcporter install based-page --target openclaw

Restart OpenClaw after installing. Based Page tools will be available in all conversations.

Alternatively, paste this prompt directly into any OpenClaw conversation:

Install the based-page MCP server so I can deploy web pages, apps, and sites to live URLs at {slug}.based.page. No git, no CI, no config required. Set it up using mcporter: mcporter install based-page --target openclaw


Claude Desktop

Add Based Page to your MCP configuration file:

json
// ~/Library/Application Support/Claude/claude_desktop_config.json
{
  "mcpServers": {
    "based-page": {
      "command": "npx",
      "args": ["-y", "based-page@latest"]
    }
  }
}
json
// %APPDATA%\Claude\claude_desktop_config.json
{
  "mcpServers": {
    "based-page": {
      "command": "npx",
      "args": ["-y", "based-page@latest"]
    }
  }
}

After saving, restart Claude Desktop for the changes to take effect.


Cursor

Open Cursor Settings → MCP and add a new server, or create .cursor/mcp.json in your project root:

json
{
  "mcpServers": {
    "based-page": {
      "command": "npx",
      "args": ["-y", "based-page@latest"]
    }
  }
}

Claude Code

Add .mcp.json to your project root. Commit it so your whole team gets Based Page automatically:

json
{
  "mcpServers": {
    "based-page": {
      "command": "npx",
      "args": ["-y", "based-page@latest"]
    }
  }
}

For global access across all projects, add it to ~/.claude/.mcp.json instead.

Great for deploying your own codebase

Claude Code reads your project files and can deploy your actual app to based.page - no separate deploy setup needed.


Windsurf

Create or edit .windsurf/mcp.json in your project:

json
{
  "mcpServers": {
    "based-page": {
      "command": "npx",
      "args": ["-y", "based-page@latest"]
    }
  }
}

Other MCP Clients

Any MCP-compatible client can run Based Page over stdio:

bash
npx -y based-page@latest

CLI (No MCP Client Required)

Based Page works as a standalone CLI. No config, no client - just npx:

bash
# Deploy a file
npx based-page deploy --file index.html --slug my-site --title "My Site"

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

# Update a deployment
npx based-page update --id dep_abc123 --file index.html

# List deployments
npx based-page list

# Check a deployment
npx based-page status --id dep_abc123

# Tear down
npx based-page teardown --id dep_abc123

# Auth
npx based-page login
npx based-page logout
npx based-page whoami

See the full CLI reference for all options.

No account required

The CLI auto-provisions an agent identity on first deploy. Just run it - no login needed. Run npx based-page login later to claim pages under a real account.


Verify Installation

MCP: Open a conversation and ask:

"What Based Page tools do you have available?"

You should see tools like deploy, update, login, list_deploys, etc.

CLI:

bash
npx based-page help

Troubleshooting

IssueFix
Tools don't appearRestart the client after editing the config
npx command failsEnsure Node.js 18+ is installed and npx is in your PATH
Permission errorsCheck write access to the config file location
Tools appear but auth failsRun npx based-page whoami to check credentials

Deploy apps from conversation.