@wranglr/cli
v1.0.8
Published
CLI tool for Wranglr.co.za - Deploy static sites to the Edge
Maintainers
Readme
@wranglr/cli
The official command-line interface for Wranglr.co.za.
Designed for developers and modern agencies, the Wranglr CLI provides a frictionless local-to-edge deployment pipeline. With a single command, you can deploy static assets, single-page applications, and compiled frameworks directly to Cloudflare's global edge network through your Wranglr account.
📦 Installation
Install the package globally via npm to access the wranglr command from anywhere on your system:
npm install -g @wranglr/cli🔑 Authentication
To interact with the platform, you must first authenticate the CLI with your Wranglr account.
wranglr login
- Generate a personal API Token from your Dashboard Settings.
- Run the login command in your terminal:
wranglr login - Paste the token when prompted. The CLI explicitly encrypts and stores this session locally.
wranglr whoami
Verify your current authentication status and active user profile:
wranglr whoamiwranglr logout
Removes your local session and API token.
wranglr logout🚀 Deployment Workflows
The CLI handles automatic compression, diffing, and uploading of static assets natively to the Wranglr Edge Network (backed by R2).
wranglr list
View a comprehensive list of all your active projects, their current deployment status, and their assigned unique origins or custom domains.
wranglr listwranglr deploy
The core command to ship code. You can target a specific build folder or a pre-packaged .zip file. The CLI recursively detects files, assigns correct MIME types, and synchronizes them to your store ID.
Deploying a Directory (e.g., React/Vue/Vite outputs):
# Navigate to your compiled output directory
cd dist
# Deploy linking to your specific site hostname or ID
wranglr deploy --site my-site.comDeploying an Archive:
Have a legacy client providing .zip drops? Just point the CLI to it:
wranglr deploy ./website.zip --site my-site.comFlags & Options:
| Flag | Description | Mandatory |
|---|---|---|
| --site | The registered hostname or absolute Site ID you wish to deploy assets to. | Yes |
Note: Deployment will immediately invalidate cache for the associated Edge assets, making updates globally live within seconds.
🛠 Advanced Usage & CI/CD
When executing deployments in automated environments (like GitHub Actions), ensure the WRANGLR_API_TOKEN environment variable is injected into the runner. The CLI will gracefully bypass interactive authentication prompts if this token is universally present.
Help & Support
To view the in-terminal help manual for any command, utilize the --help flag:
wranglr --help
wranglr deploy --helpFor platform issues, billing, or feature requests, contact [email protected] or use the chat widget inside the merchant dashboard.
