Getting started
Quickstart
Deploy your first file in under 60 seconds.
Get from zero to a live public URL in three commands.
1. Install the CLI
npm install -g @deplo/cliOr use npx without installing:
npx @deplo/cli <command>2. Log in
Create an API token at app.deplo.sh/dashboard/tokens, then:
deplo login --token sk_live_xxxxxxxxxxxxxxxx
# ✔ API token stored.
# ✔ Active workspace: My Workspace3. Deploy
Single file:
deplo deploy report.html --project weekly-report
# ✔ Uploading...
# ✔ Deployed to https://weekly-report.deplo.shStatic site (directory):
deplo deploy ./dist --project my-app --type static_site --ttl forever
# ✔ Uploading 14 files...
# ✔ Deployed to https://my-app.deplo.shJSON API endpoint:
echo '{"status":"ok","data":[1,2,3]}' | deplo deploy - \
--project status-api --type json_api --ttl 24h
# ✔ Deployed to https://status-api.deplo.shThat's it. Your content is live at a globally unique URL.
Non-interactive / CI mode
For scripts, CI pipelines, or AI agents, set DEPLO_KEY to deploy without any prompts:
# Set once in your environment
export DEPLO_KEY=sk_live_xxxxxxxxxxxxxxxx
# Deploy without any interactive prompts
deplo deploy report.html --project weekly-report --jsonCreate tokens from the dashboard or via the CLI:
deplo tokens create "CI Deploy" --scopes deployWhat's next?
- Authentication — understand all auth options
- CLI Reference — full command documentation
- MCP Server — use deplo.sh from Claude, Cursor, and other agent hosts
- TypeScript SDK — typed SDK for Node.js agents
- REST API — the HTTP API that all integrations use under the hood
- Core Concepts — understand projects, deployments, and TTL