naro-cli 0.2.1 → 0.3.0

package/README.md

@@ -1,8 +1,116 @@
 # naro-cli
 
-Deploy Next.js apps to naro from your terminal.
+Deploy Next.js apps to [Naro](https://naro.sh) from your terminal — a
+Vercel-style workflow on Cloudflare Workers for Platforms.
 
-    npx naro-cli login
-    npx naro-cli deploy --name my-app
+```bash
+npm install -g naro-cli
 
-Auth is via `naro login` (GitHub). No Cloudflare credentials needed.
+naro login          # GitHub sign-in (browser)
+cd my-nextjs-app
+naro deploy         # preview deployment
+naro deploy --prod  # production deployment
+```
+
+The first `naro deploy` creates the project (named after `package.json`),
+seeds it with your local `.env` values, links the directory via
+`.naro/project.json` (gitignored automatically) and prints the live URL.
+From then on the platform owns env vars (`naro env add/remove/pull`) —
+later deploys do not re-upload local dotenv files. No Cloudflare
+credentials are ever needed.
+
+## Commands
+
+```text
+naro login | logout | whoami
+naro token                         Print an access token for CI (NARO_TOKEN)
+
+naro link | init                   Link this directory to a Naro project
+naro unlink                        Remove the link
+naro projects [--team <slug>]      List projects
+naro project inspect               Show the linked project
+
+naro deploy [--prod]               Build locally and deploy
+naro deployments                   List deployments
+naro inspect <deployment-id>       One deployment + build logs
+
+naro logs                          Runtime logs (production)
+naro logs <deployment-id>          Build logs of a deployment
+naro logs --type build --follow    Stream build logs until READY/FAILED
+naro logs --env preview            Preview-surface runtime logs
+
+naro env list [--reveal]           Secrets masked unless --reveal
+naro env add DATABASE_URL production
+naro env remove DATABASE_URL
+naro env pull [.env.local]
+
+naro domains list
+naro domains add www.example.com   Prints the DNS records to create
+naro domains remove www.example.com
+
+naro promote <deployment-id>       Publish a build to production
+naro rollback [deployment-id]      Back to the previous production build
+```
+
+## Machine-readable output (CI / AI agents)
+
+Every command supports `--json`: stdout carries exactly one JSON object,
+human logs move to stderr.
+
+```bash
+$ naro deploy --prod --yes --json
+{
+  "success": true,
+  "deploymentId": "…",
+  "projectId": "…",
+  "status": "READY",
+  "url": "https://my-app.naro.sh",
+  "target": "production"
+}
+```
+
+Failures carry stable codes (`NOT_LOGGED_IN`, `PROJECT_NOT_LINKED`,
+`FRAMEWORK_UNSUPPORTED`, `BUILD_FAILED`, `DEPLOYMENT_NOT_FOUND`,
+`ENV_NOT_FOUND`, `VALIDATION_FAILED`, `CONFIRMATION_REQUIRED`,
+`CANCELED`, …). A destructive command run non-interactively without
+`--yes` fails with `CONFIRMATION_REQUIRED` instead of silently doing
+nothing:
+
+```json
+{
+  "success": false,
+  "code": "BUILD_FAILED",
+  "message": "…",
+  "deploymentId": "…"
+}
+```
+
+`--yes` (or `-y`) suppresses every prompt — destructive actions
+(production rollback/promote, env/domain removal) run unconfirmed, so use it
+deliberately in automation.
+
+## CI authentication
+
+```bash
+NARO_TOKEN=$(naro token) npx naro-cli deploy --prod --yes --json
+```
+
+`naro token` prints a short-lived (~1h) access token; generate one per run.
+`--token <t>` works too. Locally, credentials live in
+`~/.naro/credentials.json` (0600).
+
+## Environment variables
+
+- Values are entered via hidden prompt or stdin — never as an argument:
+  `echo "$DATABASE_URL" | naro env add DATABASE_URL production --yes`
+- Targets: `production`, `preview`, `all` (default).
+- `naro env pull` writes `.env.local` (preview + all vars by default,
+  `--env production` for production values).
+
+## Configuration
+
+| Variable                 | Purpose                                        |
+| ------------------------ | ---------------------------------------------- |
+| `NARO_TOKEN`             | CI/agent access token (skips `naro login`)     |
+| `NARO_CONTROL_PLANE_URL` | Custom control plane (default https://naro.sh) |
+| `NARO_SUPABASE_URL/KEY`  | Auth backend override (self-hosted setups)     |

package/dist/artifact-types.d.ts

@@ -18,6 +18,9 @@ export interface DeploymentArtifact {
     compatibilityDate: string;
     compatibilityFlags: string[];
     assetsBinding: string;
+    assetsConfig?: {
+        notFoundHandling: "single-page-application" | "404-page";
+    };
 }
 /** Mirrors the build log shape from the internal build package. */
 export interface BuildLog {