Documentation

Learn Velar

Everything you need to deploy static sites with Velar. From getting started to advanced configurations.

Getting Started

Get your first site deployed in under 60 seconds. Velar requires no configuration files — just install the CLI, authenticate, and deploy.

1

Install the CLI

Install the Velar CLI globally using npm, yarn, or pnpm.

$npm install -g @camozdevelopment/velar

Or use npx for one-off deploys: npx @camozdevelopment/velar deploy

2

Authenticate

Log in using our secure device flow authentication. This opens your browser to complete the login — no API keys needed.

$velar login
Opening browser for authentication...
✓Logged in successfully
3

Deploy

Navigate to your project directory (or build output) and run deploy. Velar will auto-detect your framework and deploy instantly.

$cd my-project/dist
$velar deploy
Scanning directory...
Uploading 24 files (1.2 MB)
✓Deployed to my-project.velardev.app

CLI Reference

The Velar CLI is your primary interface for deploying and managing sites. Here are all available commands.

velar login

Authenticate with Velar using device flow. Opens your browser to complete the login.

velar deploy [directory]

Deploy a directory to Velar. Defaults to the current directory if not specified.

--name <name>Set the project name (auto-generated from directory if omitted)
--prodDeploy to production (default)
velar projects

List all your projects with their URLs and deployment status.

velar rollback [project]

Roll back a project to its previous deployment.

--to <deployment-id>Roll back to a specific deployment
velar logout

Remove your authentication credentials from this device.

velar whoami

Display the currently authenticated user.

Features

Velar comes packed with features designed for modern web development workflows.

Global Edge Network

Sites are served from 50+ edge locations worldwide for sub-50ms latency.

Automatic HTTPS

Every deployment gets free SSL/TLS certificates automatically provisioned.

Instant Rollbacks

Roll back to any previous deployment instantly via CLI or dashboard.

Device Flow Auth

Secure OAuth2 device flow authentication — no API keys to leak.

Cache Invalidation

Automatic cache purge on deploy. Your visitors always get the latest version.

SPA Support

Automatic single-page application routing with index.html fallback.

Deployments

How Deployments Work

When you run velar deploy, the following happens:

  1. 1.The CLI scans your target directory and collects all files
  2. 2.Files are compressed into a zip archive for efficient upload
  3. 3.The archive is uploaded to the Velar API over HTTPS
  4. 4.Files are extracted and stored in cloud storage with unique deployment IDs
  5. 5.The deployment is marked active and files are served via the edge network

Deployment History

Every deployment is immutable and preserved in your deployment history. You can view all previous deployments in the dashboard and roll back to any of them. Each deployment gets a unique ID and timestamp, making it easy to track what was deployed and when.

Rollbacks

Rolling back is instant because previous deployment files are never deleted. When you roll back:

# Roll back to the previous deployment
$velar rollback
✓Rolled back to deployment abc123

Projects

Creating Projects

Projects are created automatically when you first deploy. The project name is derived from the directory name, or you can specify it explicitly:

$velar deploy --name my-portfolio

Project URLs

Each project gets a unique subdomain at your-project.velardev.app. The subdomain is derived from the project name and is globally unique.

Managing Projects

Use the dashboard at velardev.app/dashboard to:

  • View all your projects and their status
  • Browse deployment history for each project
  • Roll back to previous deployments
  • Configure project settings
  • Delete projects

Custom Domains

Coming Soon

Custom domain support is currently in development. Soon you'll be able to point your own domain to any Velar project with automatic SSL certificate provisioning. In the meantime, all projects are accessible via their .velardev.app subdomain.

API Reference

Velar provides a RESTful API for programmatic access. All endpoints require authentication via Bearer token or session cookie.

POST/api/deploy

Deploy a new version of a project. Accepts a zip file upload.

Auth: Bearer token

GET/api/projects

List all projects for the authenticated user.

Auth: Bearer token or session cookie

GET/api/projects/:id

Get details for a specific project.

Auth: Bearer token or session cookie

GET/api/projects/:id/deployments

List all deployments for a project.

Auth: Bearer token or session cookie

POST/api/projects/:id/rollback

Roll back a project to a specific deployment.

Auth: Bearer token or session cookie

Troubleshooting

My deployment shows 0 files

Make sure you're running velar deploy from the correct directory (your build output, e.g., dist/ or build/). The CLI uploads all files in the target directory.

Authentication failed

Try running velar logout and then velar login again. Make sure you're completing the authentication in your browser.

My site shows a 404 error

Ensure your project includes an index.html file in the root. For SPAs, Velar automatically falls back to index.html for unmatched routes.

Deploy is slow

Large deployments with many files or large file sizes will take longer. Consider optimizing your build output by removing unnecessary files, compressing images, and minifying assets.

How do I delete a project?

Go to your dashboard at velardev.app/dashboard, navigate to the project settings, and click "Delete Project." This action is irreversible.

Can I use Velar with CI/CD?

Yes! Generate a deployment token from the dashboard and use it in your CI pipeline with the --token flag or VELAR_TOKEN environment variable.

Need help?

Can't find what you're looking for? Reach out and we'll help you get deployed.

Contact Support