nivii 0.2.0 → 0.2.1

package/dist/cli.js

@@ -92,7 +92,7 @@ cli
     .action(async (slug) => {
     await runAnalytics(slug);
 });
-cli.version('0.2.0');
+cli.version('0.1.8');
 // ─── Show help when no command given ─────────────────────────────────────────
 cli.parse(process.argv, { run: false });
 if (!cli.matchedCommand) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nivii",
-  "version": "0.2.0",
+  "version": "0.2.1",
   "description": "⚡ The fastest, most beautiful way to share any local project via a live URL",
   "type": "module",
   "bin": {
@@ -45,7 +45,8 @@
     "url": "https://github.com/Aadigarg111/Nivi-sh.git"
   },
   "homepage": "https://nivii.app",
-  "bugs": {
-    "url": "mailto:contact@nivii.app"
+  "author": {
+    "name": "Aadi Garg",
+    "email": "contact@aadigarg.in"
   }
 }

package/README.md

@@ -1,385 +0,0 @@
-```
- ███╗   ██╗██╗██╗   ██╗██╗██╗
- ████╗  ██║██║██║   ██║██║██║
- ██╔██╗ ██║██║██║   ██║██║██║
- ██║╚██╗██║██║╚██╗ ██╔╝██║██║
- ██║ ╚████║██║ ╚████╔╝ ██║██║
- ╚═╝  ╚═══╝╚═╝  ╚═══╝  ╚═╝╚═╝
-```
-
-<div align="center">
-
-[![npm version](https://img.shields.io/npm/v/nivii?color=7C3AED&label=npm&logo=npm&style=for-the-badge)](https://www.npmjs.com/package/nivii)
-[![License: AGPL-3.0](https://img.shields.io/badge/License-AGPL--3.0-7C3AED?style=for-the-badge)](https://github.com/Aadigarg111/Nivi-sh/blob/main/LICENSE)
-[![Made with ❤️](https://img.shields.io/badge/Made_with-❤️-EF4444?style=for-the-badge)](#)
-[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-10B981?style=for-the-badge)](https://github.com/Aadigarg111/Nivi-sh/pulls)
-
-**⚡ The fastest, most beautiful way to share any local dev project. No accounts. No config. Just share.**
-
-[Website](https://nivii.app) · [npm](https://www.npmjs.com/package/nivii) · [Issues](https://github.com/Aadigarg111/Nivi-sh/issues)
-
-</div>
-
----
-
-## Install
-
-```bash
-npm i -g nivii
-```
-
-```bash
-# or with pnpm
-pnpm add -g nivii
-
-# or with bun
-bun add -g nivii
-```
-
----
-
-## Quick Start
-
-```bash
-# Navigate to any project
-cd ~/my-awesome-project
-
-# Share it instantly
-nivii share
-```
-
-**Example output:**
-
-```
-  ⚡  NIVII  v0.1.0
-
-  🔍  Detecting project type…  ~/my-awesome-project
-  ✓  Detected Next.js (99% confidence)
-  ✓  Build complete (nextjs)
-  📦  Compressing project…
-  ✓  Deployed to edge (xk9m2pqr)
-
-  ╭─────────────────────────────────────────────────╮
-  │                                                 │
-  │    🚀  Your project is live!                    │
-  │                                                 │
-  │    URL:      https://xk9m2pqr.nivii.app         │
-  │    Expires:  in 48 hours                        │
-  │                                                 │
-  ╰─────────────────────────────────────────────────╯
-
-  ✓  URL copied to clipboard
-
-  ┌─────────────────────────────────┐
-  │   Scan to open on mobile        │
-  └─────────────────────────────────┘
-
-  [QR CODE HERE]
-```
-
----
-
-## Features
-
-| Emoji | Feature | Description |
-|-------|---------|-------------|
-| 🔍 | **Smart Detection** | Auto-detects framework, build command, and output directory |
-| ⚡ | **Live Sync** | Watch for file changes and auto-redeploy (Pro) |
-| 🔒 | **Password Protection** | Password or OTP-protect any deployment |
-| 🔗 | **Custom Slugs** | Get `my-demo.nivii.app` instead of random strings (Pro) |
-| 📱 | **QR Codes** | Instant QR code printed in terminal |
-| 📋 | **Clipboard** | URL auto-copied to clipboard |
-| 🌐 | **Auto-open** | Browser opens automatically after deploy |
-| 📊 | **Analytics** | Privacy-first view counts and visitor data (Pro) |
-| 💥 | **Self-Destruct** | Links that expire after N views or a duration |
-| 🤝 | **Collab Previews** | Real-time collaborative previews (Pro) |
-| 🌍 | **Edge CDN** | Deployed on Cloudflare's global network |
-| 🎨 | **Beautiful UI** | Futuristic terminal UI with gradients and spinners |
-
----
-
-## All Flags — `nivii share`
-
-| Flag | Type | Default | Description |
-|------|------|---------|-------------|
-| `--dir <dir>` | string | cwd | Directory to deploy |
-| `--slug <slug>` | string | random | Custom slug — e.g. `my-demo` → `my-demo.nivii.app` (Pro) |
-| `--pass <password>` | string | — | Password-protect the deployment |
-| `--otp` | boolean | false | Enable one-time password access |
-| `--expires <duration>` | string | 48h | Expiry: `1h` / `24h` / `7d` / `30d` / `never` |
-| `--live` | boolean | false | Enable live sync — watch & auto-redeploy on changes (Pro) |
-| `--collab` | boolean | false | Real-time collaborative preview (Pro) |
-| `--no-build` | boolean | false | Skip build step, use existing output directory |
-| `--cmd <cmd>` | string | auto | Custom build command |
-| `--port <port>` | number | 3000 | Port for server-mode proxy |
-| `--max-views <n>` | number | — | Self-destruct after N views |
-| `--self-destruct` | boolean | false | Destroy after first view |
-| `--no-qr` | boolean | false | Skip QR code display |
-| `--no-open` | boolean | false | Don't auto-open browser |
-
----
-
-## All Commands
-
-```bash
-nivii share          # Deploy current directory
-nivii ls             # List recent deployments
-nivii analytics      # View analytics for a deployment
-nivii config         # View/set config values
-nivii whoami         # Show current account info
-nivii --help         # Show all commands
-```
-
----
-
-## Framework Support
-
-| Framework | Detection | Build Command | Output Directory |
-|-----------|-----------|---------------|-----------------|
-| **Next.js** | `package.json` `next` dep | `npm run build` | `out` / `.next` |
-| **Vite** | `package.json` `vite` dep | `npm run build` | `dist` |
-| **React (CRA)** | `vite` + `react` deps | `npm run build` | `dist` |
-| **Vue** | `vite` + `vue` deps | `npm run build` | `dist` |
-| **Svelte** | `vite` + `svelte` deps | `npm run build` | `dist` |
-| **SvelteKit** | `@sveltejs/kit` dep | `npm run build` | `build` |
-| **Astro** | `astro` dep | `npm run build` | `dist` |
-| **Remix** | `@remix-run/*` deps | `npm run build` | `public` |
-| **Nuxt** | `nuxt` dep | `npm run generate` | `.output/public` |
-| **Solid.js** | `vite` + `solid-js` deps | `npm run build` | `dist` |
-| **Express** | `express` dep | — (server mode) | `.` |
-| **Fastify** | `fastify` dep | — (server mode) | `.` |
-| **Hono** | `hono` dep | — (server mode) | `.` |
-| **Static HTML** | `index.html` exists | — | `.` / `dist` / `build` |
-
----
-
-## Architecture
-
-```
-User runs: nivii share
-      │
-      ▼
-┌─────────────────────────────────────────────────────────┐
-│  Nivii CLI (Node.js)                                     │
-│                                                          │
-│  1. detectFramework()  → identifies build system         │
-│  2. runBuild()         → executes build command          │
-│  3. zipDirectory()     → zips output dir                 │
-│  4. uploadDeploy()     → POST /deploy to API             │
-│  5. showQR()           → renders QR in terminal          │
-│  6. startLiveSync()    → WebSocket watcher (--live)      │
-└──────────────────────────────┬──────────────────────────┘
-                               │ HTTPS multipart/form-data
-                               ▼
-┌─────────────────────────────────────────────────────────┐
-│  api.nivii.app (Cloudflare Worker)                       │
-│                                                          │
-│  POST /deploy                                            │
-│  ├─ Stores metadata in KV (slug, password, expiry…)      │
-│  └─ Uploads deploy.zip to R2 bucket                      │
-└──────────────┬────────────────────────────────┬─────────┘
-               │                                │
-               ▼                                ▼
-┌──────────────────────┐          ┌─────────────────────────────┐
-│  Cloudflare R2       │          │  Cloudflare KV              │
-│  (Object Storage)    │          │  (Metadata + Analytics)     │
-│                      │          │                             │
-│  deploys/{slug}/     │          │  deploy:{slug} → JSON meta  │
-│  └─ deploy.zip       │          │  analytics:{slug} → stats   │
-└──────────────────────┘          └─────────────────────────────┘
-               │
-               ▼
-┌─────────────────────────────────────────────────────────┐
-│  *.nivii.app (Cloudflare Worker wildcard routing)        │
-│                                                          │
-│  GET xyz.nivii.app/                                      │
-│  ├─ Checks KV for metadata (expiry, password, OTP)       │
-│  ├─ Serves files from R2                                 │
-│  └─ SPA fallback to index.html                           │
-│                                                          │
-│  live.nivii.app/live/{slug}  (WebSocket)                 │
-│  └─ LiveSyncDO (Durable Object)                          │
-│     └─ Broadcasts reload events to connected viewers     │
-└─────────────────────────────────────────────────────────┘
-```
-
----
-
-## Self-Hosting on Cloudflare
-
-Deploy your own Nivii instance in ~10 minutes:
-
-### Prerequisites
-
-- [Cloudflare account](https://cloudflare.com) (free tier works)
-- [Wrangler CLI](https://developers.cloudflare.com/workers/wrangler/): `npm i -g wrangler`
-- Node.js 18+
-
-### Steps
-
-**1. Clone and install**
-
-```bash
-git clone https://github.com/Aadigarg111/Nivi-sh.git
-cd Nivi-sh
-npm install
-```
-
-**2. Create Cloudflare resources**
-
-```bash
-# Login to Cloudflare
-wrangler login
-
-# Create KV namespace
-wrangler kv:namespace create "DB"
-wrangler kv:namespace create "DB" --preview
-
-# Create R2 bucket
-wrangler r2 bucket create nivii-deployments
-```
-
-**3. Update wrangler.toml**
-
-```toml
-# packages/worker/wrangler.toml
-[[kv_namespaces]]
-binding = "DB"
-id = "YOUR_ACTUAL_KV_ID"          # from step 2
-preview_id = "YOUR_PREVIEW_KV_ID"
-
-[[r2_buckets]]
-binding = "BUCKET"
-bucket_name = "nivii-deployments"
-```
-
-**4. Deploy the worker**
-
-```bash
-cd packages/worker
-wrangler deploy
-```
-
-**5. Configure DNS**
-
-Add a wildcard DNS record:
-```
-Type: CNAME
-Name: *
-Target: your-worker.workers.dev
-Proxy: Enabled (orange cloud)
-```
-
-**6. Point the CLI at your instance**
-
-```bash
-export NIVII_API=https://api.your-domain.com
-
-# Or in config
-nivii config apiBase https://api.your-domain.com
-```
-
----
-
-## Configuration
-
-Config is stored at `~/.nivii/config.json`:
-
-```json
-{
-  "token": "your-pro-token",
-  "plan": "free",
-  "apiBase": "https://api.nivii.app",
-  "deployments": [...]
-}
-```
-
-Manage it:
-
-```bash
-nivii config              # show all
-nivii config token <tok>  # set token
-nivii config apiBase <url> # point to self-hosted instance
-```
-
----
-
-## Roadmap v2
-
-- [ ] **Team workspaces** — share deployments with your team
-- [ ] **Custom domains** — deploy to `preview.your-company.com`
-- [ ] **GitHub Actions integration** — auto-share on every PR
-- [ ] **VS Code extension** — deploy with a keyboard shortcut
-- [ ] **Mobile app** — scan QR codes from Nivii deployments
-- [ ] **Zip-streaming upload** — faster uploads for large projects
-- [ ] **Screenshot previews** — auto-thumbnail for each deployment
-- [ ] **API keys + webhooks** — programmatic deployments
-- [ ] **Deployment history UI** — web dashboard at `app.nivii.app`
-- [ ] **SSR support** — run Express/Fastify apps in serverless mode
-- [ ] **Monorepo support** — deploy multiple packages at once
-
----
-
-## Contributing
-
-Contributions are welcome! This is an AGPL-3.0 open-source project.
-
-```bash
-# Fork and clone
-git clone https://github.com/YOUR_USERNAME/Nivi-sh.git
-cd Nivi-sh
-
-# Install dependencies
-npm install
-
-# Build CLI
-cd packages/cli && npm run build
-
-# Run locally
-node dist/cli.js share --help
-```
-
-### Project structure
-
-```
-packages/cli/     - The NPM CLI tool (published as `nivii`)
-packages/worker/  - Cloudflare Worker backend
-landing/          - Landing page HTML
-.github/          - GitHub Actions workflows
-```
-
-### Submitting PRs
-
-1. Fork the repository
-2. Create a feature branch: `git checkout -b feat/my-feature`
-3. Commit your changes: `git commit -m 'feat: add something cool'`
-4. Push to your fork: `git push origin feat/my-feature`
-5. Open a Pull Request
-
-Please follow conventional commits and keep PRs focused.
-
----
-
-## License
-
-```
-Nivii — Futuristic Project Sharing CLI
-Copyright (C) 2025 Aadigarg111
-
-This program is free software: you can redistribute it and/or modify
-it under the terms of the GNU Affero General Public License as published by
-the Free Software Foundation, either version 3 of the License, or
-(at your option) any later version.
-```
-
-**[AGPL-3.0](./LICENSE)** — See the LICENSE file for full terms.
-
----
-
-<div align="center">
-
-Made with ❤️ by [Aadigarg111](https://github.com/Aadigarg111)
-
-⚡ [nivii.app](https://nivii.app) · [npm](https://www.npmjs.com/package/nivii) · [GitHub](https://github.com/Aadigarg111/Nivi-sh)
-
-</div>