⚡ What is Velocitea?

Velocitea is a zero-config CLI that takes your web project from local to live in one command. It auto-detects your framework, builds the project if needed, and gives you a shareable URL instantly.

No YAML. No CI pipeline setup. No dashboard clicking. Just one command and you're live.

npx velocitea share

📦 Install

# Use directly with npx (recommended, always up to date)
npx velocitea <command>

# Or install globally
npm i -g velocitea

🚀 Quick Start

Share instantly (no account needed)

npx velocitea share

✔ Found React/Vite project.
✔ Building project with npm run build...
✔ Share successful!
URL: https://velocitea.quorix.pl/s/a1b2c3d4-...
Expires: 24 hours

Deploy to production

npx velocitea auth    # one-time browser login
npx velocitea deploy  # permanent URL on Cloudflare Pages

🎯 Commands

velocitea share

Create a temporary preview link for your project. Expires in 24 hours. No authentication required.

# Standard share
npx velocitea share

# Share with a custom name (e.g. s/my-feature)
npx velocitea share --name my-feature

# Protect share with a password
npx velocitea share --pass secret123

velocitea share --client

Same as share, but injects an embedded feedback widget so your client can leave comments and approve the build directly from the preview.

npx velocitea share --client

velocitea open

Quickly open the last shared or deployed project in your default browser.

npx velocitea open

velocitea deploy

Deploy your project to a permanent, production-ready URL powered by Cloudflare Pages. Requires authentication.

# Standard deploy
npx velocitea deploy

# Deploy with custom project name (e.g. my-project.velocitea.sh)
npx velocitea deploy --name my-project

velocitea auth

Opens your browser for a secure login flow. Your credentials are stored locally in ~/.velocitea/config.json and never leave your machine.

npx velocitea auth

velocitea whoami

Check which account you're currently authenticated with.

npx velocitea whoami

  Account:  [email protected]
  Status:   ● Authenticated

velocitea logout

Remove saved credentials from your machine.

npx velocitea logout

velocitea config

Manage custom API and client URLs (useful for self-hosting).

# Set custom API endpoint
npx velocitea config set api https://your-api.example.com/api/v1

# Set custom client URL
npx velocitea config set client https://your-app.example.com

# View current config
npx velocitea config get

# Reset everything
npx velocitea config clear

Environment variables are also supported:

export VELOCITY_API_URL=https://your-api.example.com/api/v1
export VELOCITY_CLIENT_URL=https://your-app.example.com

🔥 Features

Zero-Config Framework Detection

Velocitea automatically detects your framework and knows where to find the build output:

| Framework | Build Directory | Auto-detected via | |-----------|-----------------|-------------------| | Next.js | .next | next in dependencies | | Remix | build/client | @remix-run/dev in dependencies | | Gatsby | public | gatsby in dependencies | | SvelteKit | build | @sveltejs/kit in dependencies | | Svelte | public/build | svelte in dependencies | | Astro | dist | astro in dependencies | | Angular | dist | @angular/cli in dependencies | | SolidJS | dist | solid-js in dependencies | | Create React App | build | react-scripts in dependencies | | Nuxt | .output/public | nuxt in dependencies | | Vite | dist | vite in dependencies | | Static HTML | . (current dir) | No package.json found |

Always Fresh Builds

Every share and deploy runs a fresh npm run build to ensure you're always uploading the latest version of your code. No stale builds, ever.

Auto-Install

Missing node_modules? Velocitea runs npm install automatically before building.

Client Review Mode

Need feedback from a client or teammate? The --client flag injects a feedback bar directly into the shared preview — your client can comment and approve without signing up for anything.

Password Protection

Secure your shared previews with a passphrase. Anyone visiting the link will be prompted with a clean, branded login screen. Only those with the correct password can view your project.

Custom Slugs (Branding)

Make your preview links professional by specifying a custom name via --name. Instead of random letters, you get a clean URL like /s/marketing-v2.

Professional CLI Progress Bars

See exactly what's happening during upload. Velocitea shows a real-time progress bar with upload speed, percentage, and MB transfer.

Temporary Sharing (24h)

velocitea share creates a link that self-destructs after 24 hours. Perfect for quick demos, code reviews, and stakeholder previews. No account required.

Permanent Deployments

velocitea deploy pushes to Cloudflare Pages — production-grade, globally distributed, permanent URLs. Requires a free account.

📁 How It Works

Your Project
    │
    ├── 1. Detect framework (Next.js, Vite, CRA, Nuxt, Static)
    ├── 2. Auto-install dependencies (if node_modules missing)
    ├── 3. Run fresh build (npm run build)
    ├── 4. Compress build output
    └── 5. Upload → get your URL ✨

🆚 Why Velocitea?

| | Velocitea | Vercel CLI | Netlify CLI | Surge | |---|---|---|---|---| | Zero config | ✅ | ⚠️ Needs setup | ⚠️ Needs setup | ✅ | | One command deploy | ✅ | ✅ | ❌ | ✅ | | Temporary sharing | ✅ 24h links | ❌ | ❌ | ❌ | | Client feedback mode | ✅ Built-in | ❌ | ❌ | ❌ | | Auto-build | ✅ Always fresh | ✅ | ✅ | ❌ | | No account for sharing | ✅ | ❌ | ❌ | ❌ | | Package size | ~8 kB | ~20 MB | ~50 MB | ~1 MB |

🛠️ Requirements

• Node.js 18+
• npm 9+
• Works on macOS, Linux, and Windows

🤝 Contributing

Contributions are welcome! See CONTRIBUTING.md for guidelines.

📜 License

MIT © Velocitea

🔒 Security

Found a vulnerability? See SECURITY.md for responsible disclosure.