@deplo/cli
v0.2.0
Published
deplo.sh CLI — Deploy anything from anywhere
Maintainers
Readme
deplo CLI
The official command-line interface for deplo.sh — publish HTML files, static sites, and JSON APIs to a live URL in a single command.
npm install -g @deplo/cliAuthentication
The CLI authenticates exclusively with API tokens (sk_live_...). Create one at app.deplo.sh/dashboard/tokens.
deplo login --token sk_live_...
# or set the env var for one-off deploys (no login needed):
DEPLO_KEY=sk_live_... deplo deploy ./distCommands
deplo deploy <path>
Deploy a file, directory, or stdin stream.
# Deploy a single file
deplo deploy report.json --project weekly-report
# Deploy a static site directory
deplo deploy ./dist --project my-site --type static_site
# Deploy from stdin
cat data.json | deplo deploy -
# Use an API token inline (no login required)
DEPLO_KEY=sk_live_... deplo deploy ./dist --project my-app --open| Flag | Default | Description |
| ------------------ | ------------- | -------------------------------------------- |
| --project <slug> | — | Target project (auto-created if missing) |
| --type <type> | static_file | static_file | static_site | json_api |
| --ttl <duration> | 7d | 1h | 24h | 7d | 30d | forever |
| --entry <path> | index.html | Entry point for static_site |
| --open | — | Open the deployed URL in your browser |
| --json | — | Machine-readable JSON output |
deplo projects
deplo projects list # List all projects
deplo projects create my-app --type static_site # Create a project
deplo projects get my-app # Get details by slug or ID
deplo projects update my-app --name "New Name" # Rename a project
deplo projects update my-app --domain reports.acme.com # Attach a custom domain
deplo projects update my-app --domain "" # Remove custom domain
deplo projects update my-app --ttl 30d # Change default TTL
deplo projects verify-domain my-app # Verify DNS after adding CNAME
deplo projects delete my-app # Delete (with confirmation)deplo tokens
Manage API access tokens for scripting and CI.
deplo tokens list # List all tokens
deplo tokens create ci-token --scopes deploy
deplo tokens create ci-token --scopes deploy,read --expires 2026-12-31
deplo tokens revoke <tokenId>deplo deployments
deplo deployments list <project> # List deployments for a project
deplo deployments promote <project> <deploymentId> # Promote (roll back to) a version
deplo deployments archive <project> <deploymentId> # Archive an old deploymentOther commands
deplo whoami # Show current logged-in user
deplo logout # Clear local credentials
deplo billing # View billing info for the workspaceCI / GitHub Actions example
- name: Deploy to deplo.sh
env:
DEPLO_KEY: ${{ secrets.DEPLO_KEY }}
run: |
npx @deplo/cli deploy ./dist --project my-site --type static_site --jsonLinks
- Website: https://deplo.sh
- Dashboard: https://app.deplo.sh
- Docs: https://deplo.sh/docs
- Support: [email protected]
