create-runway-app 1.0.0

package/README.md

@@ -0,0 +1,50 @@
+# create-runway-app
+
+Scaffold a RunwayJS project from the terminal.
+
+## Usage
+
+```bash
+npx create-runway-app@latest
+npx create-runway-app@latest my-app
+```
+
+## Requirements
+
+- **RunwayJS access** — Purchase at [runwayjs.com/pricing](https://runwayjs.com/pricing)
+- **API key** — Generate at [runwayjs.com/dashboard/download](https://runwayjs.com/dashboard/download) (CLI Access section)
+
+## Authentication
+
+**Enter your API key once** — it's stored in `~/.config/runwayjs/api-key` for future runs. No need to type it again.
+
+```bash
+# First run: prompted for key, then saved
+npx create-runway-app@latest
+
+# Later runs: key read automatically
+npx create-runway-app@latest my-new-app
+```
+
+Override with environment variable:
+
+```bash
+RUNWAY_API_KEY=runway_xxx npx create-runway-app@latest
+```
+
+Clear stored key:
+
+```bash
+npx create-runway-app@latest --clear-key
+```
+
+## Publishing to npm
+
+From the package directory:
+
+```bash
+cd packages/create-runway-app
+npm publish --access public
+```
+
+For scoped or private registry, configure `.npmrc` with your token.

package/index.mjs

@@ -0,0 +1,359 @@
+#!/usr/bin/env node
+
+/**
+ * create-runway-app
+ * Scaffold a RunwayJS project from the terminal.
+ *
+ * Usage:
+ *   npx create-runway-app@latest
+ *   npx create-runway-app@latest my-app
+ *   RUNWAY_API_KEY=xxx npx create-runway-app@latest
+ *   npx create-runway-app@latest --defaults
+ *   npx create-runway-app@latest --clear-key   # remove stored API key
+ *
+ * API key: Enter once, stored in ~/.config/runwayjs/api-key. Set RUNWAY_API_KEY
+ * to override. Subsequent runs skip the key prompt.
+ */
+
+import { existsSync, mkdirSync, readFileSync, readdirSync, writeFileSync } from "node:fs";
+import { homedir, tmpdir } from "node:os";
+import { dirname, join } from "node:path";
+import chalk from "chalk";
+import extract from "extract-zip";
+import minimist from "minimist";
+import prompts from "prompts";
+
+const API_BASE =
+  process.env.RUNWAY_API_URL || "https://runwayjs.com";
+
+const CONFIG_DIR = join(
+  process.env.XDG_CONFIG_HOME || join(homedir(), ".config"),
+  "runwayjs"
+);
+const API_KEY_FILE = join(CONFIG_DIR, "api-key");
+
+const DEFAULT_THEME = {
+  primary: "262 83% 58%",
+  background: "0 0% 100%",
+  foreground: "222 47% 11%",
+  muted: "210 40% 96%",
+  card: "0 0% 100%",
+  border: "214 32% 91%",
+  radius: "0.5rem",
+};
+
+const FALLBACK_SELECTIONS = {
+  homepage: "default",
+  auth: "default",
+  dashboard: "default",
+  docs: "default",
+  blog: "default",
+};
+
+function getStoredApiKey() {
+  try {
+    if (existsSync(API_KEY_FILE)) {
+      return readFileSync(API_KEY_FILE, "utf8").trim();
+    }
+  } catch {
+    // ignore
+  }
+  return null;
+}
+
+function saveApiKey(key) {
+  try {
+    if (!existsSync(dirname(API_KEY_FILE))) {
+      mkdirSync(dirname(API_KEY_FILE), { recursive: true, mode: 0o700 });
+    }
+    writeFileSync(API_KEY_FILE, key.trim() + "\n", { mode: 0o600 });
+  } catch (err) {
+    // non-fatal — user can still use env
+  }
+}
+
+function clearStoredApiKey() {
+  try {
+    if (existsSync(API_KEY_FILE)) {
+      writeFileSync(API_KEY_FILE, "");
+    }
+  } catch {
+    // ignore
+  }
+}
+
+function getApiKey() {
+  return (
+    process.env.RUNWAY_API_KEY ||
+    process.env.RUNWAY_TOKEN ||
+    getStoredApiKey()
+  );
+}
+
+async function fetchTemplates() {
+  try {
+    const res = await fetch(`${API_BASE}/api/cli/templates`);
+    if (!res.ok) return null;
+    return await res.json();
+  } catch {
+    return null;
+  }
+}
+
+async function fetchProjects(apiKey) {
+  const res = await fetch(`${API_BASE}/api/projects`, {
+    headers: { Authorization: `Bearer ${apiKey}` },
+  });
+  if (!res.ok) return [];
+  const data = await res.json();
+  return data.projects ?? [];
+}
+
+async function validateApiKey(apiKey) {
+  const res = await fetch(`${API_BASE}/api/projects`, {
+    headers: { Authorization: `Bearer ${apiKey}` },
+  });
+  return res.ok || res.status === 403; // 403 = has key but no access
+}
+
+async function downloadProject(apiKey, projectIdOrConfig, projectDir) {
+  const body = typeof projectIdOrConfig === "string"
+    ? { projectId: projectIdOrConfig }
+    : { selections: projectIdOrConfig.selections, theme: projectIdOrConfig.theme };
+
+  const res = await fetch(`${API_BASE}/api/download`, {
+    method: "POST",
+    headers: {
+      "Content-Type": "application/json",
+      Authorization: `Bearer ${apiKey}`,
+    },
+    body: JSON.stringify(body),
+  });
+
+  if (!res.ok) {
+    const data = await res.json().catch(() => ({}));
+    const msg = data.error || `Download failed (${res.status})`;
+    const err = new Error(msg);
+    err.status = res.status;
+    throw err;
+  }
+
+  const buffer = await res.arrayBuffer();
+  const zipPath = join(tmpdir(), `runwayjs-${Date.now()}.zip`);
+  writeFileSync(zipPath, Buffer.from(buffer));
+  await extract(zipPath, { dir: projectDir });
+  return zipPath;
+}
+
+function toChoices(items) {
+  return items.map((t) => ({ title: t.name, value: t.slug }));
+}
+
+async function main() {
+  const argv = minimist(process.argv.slice(2));
+  const projectArg = argv._[0];
+  const useDefaults = argv.defaults === true;
+  const clearKey = argv["clear-key"] === true;
+
+  if (clearKey) {
+    clearStoredApiKey();
+    console.log(chalk.gray("\n  Stored API key cleared.\n"));
+    return;
+  }
+
+  console.log(chalk.bold("\n  Runway.js\n"));
+  console.log(chalk.gray("  Scaffold a production-ready Next.js project.\n"));
+
+  let apiKey = getApiKey();
+
+  if (!apiKey && !useDefaults) {
+    const { token } = await prompts({
+      type: "password",
+      name: "token",
+      message: "API key (get one at runwayjs.com/dashboard/download):",
+      validate: (v) => (v && v.startsWith("runway_") ? true : "Invalid key format"),
+    });
+    if (!token) process.exit(1);
+    apiKey = token;
+
+    // Validate and persist — only save if it works
+    const valid = await validateApiKey(apiKey);
+    if (valid) {
+      saveApiKey(apiKey);
+      console.log(chalk.gray("  Key saved for future runs.\n"));
+    } else {
+      const data = await fetch(`${API_BASE}/api/projects`, {
+        headers: { Authorization: `Bearer ${apiKey}` },
+      }).then((r) => r.json().catch(() => ({})));
+      if (data.error?.includes("Purchase") || data.error?.includes("access")) {
+        console.error(chalk.red(`\n  ${data.error}\n`));
+        console.error(chalk.yellow("  Get access at runwayjs.com/pricing\n"));
+      } else {
+        console.error(chalk.red("\n  Invalid API key. Check runwayjs.com/dashboard/download\n"));
+      }
+      process.exit(1);
+    }
+  }
+
+  if (!apiKey) {
+    if (useDefaults) {
+      console.error(chalk.red("\n  --defaults requires RUNWAY_API_KEY or a stored key.\n"));
+    } else {
+      console.error(chalk.red("\n  Invalid API key. Get one at runwayjs.com/dashboard/download\n"));
+    }
+    process.exit(1);
+  }
+
+  if (!apiKey.startsWith("runway_")) {
+    console.error(chalk.red("\n  Invalid API key. Get one at runwayjs.com/dashboard/download\n"));
+    process.exit(1);
+  }
+
+  // ── Scaffold from: saved apps or scratch ─────────────────────────────────
+  let downloadConfig;
+  let projects = [];
+
+  if (useDefaults) {
+    const tmpl = await fetchTemplates();
+    const defaultSelections = tmpl?.defaultSelections ?? FALLBACK_SELECTIONS;
+    downloadConfig = {
+      selections: { ...defaultSelections },
+      theme: DEFAULT_THEME,
+    };
+  } else {
+    projects = await fetchProjects(apiKey);
+    const choices = projects.length > 0
+      ? [
+          { title: "From a saved project", value: "project" },
+          { title: "From scratch (pick templates)", value: "scratch" },
+        ]
+      : [{ title: "From scratch (pick templates)", value: "scratch" }];
+
+    const { scaffoldFrom } = await prompts({
+      type: "select",
+      name: "scaffoldFrom",
+      message: "How do you want to scaffold?",
+      choices,
+      initial: projects.length > 0 ? 0 : 0,
+    });
+
+    if (scaffoldFrom === undefined) process.exit(1);
+
+    if (scaffoldFrom === "project") {
+      const { projectId } = await prompts({
+        type: "select",
+        name: "projectId",
+        message: "Select a project:",
+        choices: projects.map((p) => ({
+          title: p.title,
+          value: p.id,
+          description: p.slug ? `→ ${p.slug}` : undefined,
+        })),
+      });
+      if (!projectId) process.exit(1);
+      downloadConfig = projectId;
+    } else {
+      const tmpl = await fetchTemplates();
+      const templatesByCat = tmpl?.templates ?? {
+        homepage: [
+          { slug: "default", name: "Default" },
+          { slug: "runway-cloud", name: "Runway Cloud" },
+          { slug: "runway-code", name: "Runway Code" },
+          { slug: "modern", name: "Runway Modern" },
+          { slug: "runway-mvp", name: "Runway MVP" },
+        ],
+      };
+      const defaultSelections = tmpl?.defaultSelections ?? FALLBACK_SELECTIONS;
+      const homepages = templatesByCat.homepage ?? templatesByCat.Homepage ?? [];
+      const items = homepages.length > 0 ? homepages : [
+        { slug: "default", name: "Default" },
+        { slug: "runway-cloud", name: "Runway Cloud" },
+        { slug: "runway-code", name: "Runway Code" },
+      ];
+
+      const { homepage } = await prompts({
+        type: "select",
+        name: "homepage",
+        message: "Homepage template:",
+        choices: toChoices(items),
+        initial: Math.max(0, items.findIndex((t) => t.slug === defaultSelections.homepage)),
+      });
+      if (homepage === undefined) process.exit(1);
+
+      downloadConfig = {
+        selections: { ...defaultSelections, homepage },
+        theme: DEFAULT_THEME,
+      };
+    }
+  }
+
+  // ── Project directory ───────────────────────────────────────────────────
+  let projectDir = projectArg;
+  let defaultDir = "my-app";
+  if (typeof downloadConfig === "string" && projects?.length) {
+    const proj = projects.find((p) => p.id === downloadConfig);
+    if (proj?.slug) defaultDir = proj.slug;
+  }
+  if (!projectDir) {
+    if (useDefaults) {
+      projectDir = "my-app";
+    } else {
+      const { dir } = await prompts({
+        type: "text",
+        name: "dir",
+        message: "Project directory:",
+        initial: defaultDir,
+        validate: (v) => (v ? true : "Required"),
+      });
+      if (!dir) process.exit(1);
+      projectDir = dir;
+    }
+  }
+
+  const absoluteDir = join(process.cwd(), projectDir);
+  try {
+    mkdirSync(absoluteDir, { recursive: true });
+  } catch (err) {
+    if (err.code === "EEXIST") {
+      const count = readdirSync(absoluteDir).length;
+      if (count > 0) {
+        console.error(chalk.red(`\n  Directory ${projectDir} already exists and is not empty.\n`));
+        process.exit(1);
+      }
+    } else throw err;
+  }
+
+  console.log(chalk.gray("\n  Downloading project…\n"));
+
+  try {
+    await downloadProject(apiKey, downloadConfig, absoluteDir);
+  } catch (err) {
+    const msg = err.message || "Unknown error";
+    console.error(chalk.red(`\n  ${msg}\n`));
+    const status = err.status || 0;
+    if (
+      msg.includes("Purchase required") ||
+      status === 401 ||
+      status === 403
+    ) {
+      console.error(chalk.yellow("  Get access at runwayjs.com/pricing\n"));
+    } else if (status >= 500) {
+      console.error(chalk.yellow("  Server error. Try again later.\n"));
+    }
+    process.exit(1);
+  }
+
+  console.log(chalk.green("  Done! Created"), chalk.bold(projectDir));
+  console.log(chalk.gray("\n  Next steps:\n"));
+  console.log(chalk.cyan(`    cd ${projectDir}`));
+  console.log(chalk.cyan("    cp .env.example .env.local  # fill in your keys"));
+  console.log(chalk.cyan("    pnpm install   # or npm install / yarn / bun install"));
+  console.log(chalk.cyan("    pnpm db:push   # or npm run db:push / yarn db:push / bun run db:push"));
+  console.log(chalk.cyan("    pnpm dev       # or npm run dev / yarn dev / bun dev"));
+  console.log("");
+}
+
+main().catch((err) => {
+  console.error(err);
+  process.exit(1);
+});

package/package.json

@@ -0,0 +1,26 @@
+{
+  "name": "create-runway-app",
+  "version": "1.0.0",
+  "description": "Scaffold a RunwayJS project from the terminal",
+  "type": "module",
+  "bin": {
+    "create-runway-app": "./index.mjs"
+  },
+  "engines": {
+    "node": ">=18"
+  },
+  "dependencies": {
+    "chalk": "^5.3.0",
+    "extract-zip": "^2.0.1",
+    "minimist": "^1.2.8",
+    "prompts": "^2.4.2"
+  },
+  "keywords": [
+    "runwayjs",
+    "nextjs",
+    "boilerplate",
+    "scaffold",
+    "create-app"
+  ],
+  "license": "MIT"
+}