renobrief 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 wujieli
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,43 @@
+# renobrief
+
+Estimate home renovation **budget ranges** by room, style, and scope — a small
+companion tool for [RenoBrief AI](https://renobrief.com), which turns a room
+photo into a redesigned image plus a contractor-ready one-page brief.
+
+## Install
+
+```bash
+npm install renobrief
+# or run directly:
+npx renobrief kitchen --style quiet_luxury --scope gut --sqft 200
+```
+
+## CLI
+
+```bash
+renobrief bathroom --style japandi --scope remodel
+# bathroom · japandi · remodel
+# Estimated budget: $5,750 – $28,750
+# Get a full visual redesign + contractor-ready brief: https://renobrief.com
+```
+
+## API
+
+```js
+import { estimate } from "renobrief";
+
+const [low, high] = estimate("kitchen", { style: "modern", scope: "remodel" });
+console.log(low, high);
+```
+
+Rooms: `bathroom`, `kitchen`, `bedroom`, `living_room`, `exterior`
+Styles: `minimalist`, `farmhouse`, `modern`, `japandi`, `quiet_luxury`
+Scopes: `refresh`, `remodel`, `gut`
+
+> Figures are planning ballparks (US market), not quotes. For an actual
+> redesigned visualization, materials list, and a brief a contractor can quote
+> against, use **[RenoBrief AI](https://renobrief.com)**.
+
+## License
+
+MIT

package/cli.js

@@ -0,0 +1,41 @@
+#!/usr/bin/env node
+// CLI entry point: `renobrief`.
+import { estimate, ROOMS, STYLES, SCOPES, HOMEPAGE } from "./index.js";
+
+function parse(argv) {
+  const args = { style: "modern", scope: "remodel", sqft: undefined, room: undefined };
+  for (let i = 0; i < argv.length; i++) {
+    const a = argv[i];
+    if (a === "--style") args.style = argv[++i];
+    else if (a === "--scope") args.scope = argv[++i];
+    else if (a === "--sqft") args.sqft = Number(argv[++i]);
+    else if (a === "--version" || a === "-v") { console.log("renobrief 0.1.0"); process.exit(0); }
+    else if (a === "--help" || a === "-h") { usage(); process.exit(0); }
+    else if (!a.startsWith("-")) args.room = a;
+  }
+  return args;
+}
+
+function usage() {
+  console.log(`Usage: renobrief <room> [--style S] [--scope S] [--sqft N]
+
+  rooms:  ${Object.keys(ROOMS).join(", ")}
+  styles: ${Object.keys(STYLES).join(", ")}
+  scopes: ${Object.keys(SCOPES).join(", ")}
+
+Full AI redesign + contractor-ready brief: ${HOMEPAGE}`);
+}
+
+const args = parse(process.argv.slice(2));
+if (!args.room) { usage(); process.exit(1); }
+
+try {
+  const [low, high] = estimate(args.room, { style: args.style, scope: args.scope, sqft: args.sqft });
+  const fmt = (n) => n.toLocaleString("en-US");
+  console.log(`${args.room} · ${args.style} · ${args.scope}`);
+  console.log(`Estimated budget: $${fmt(low)} – $${fmt(high)}`);
+  console.log(`Get a full visual redesign + contractor-ready brief: ${HOMEPAGE}`);
+} catch (e) {
+  console.error(e.message);
+  process.exit(1);
+}

package/index.js

@@ -0,0 +1,58 @@
+// renobrief — home renovation budget range estimator.
+// Companion SDK for RenoBrief AI (https://renobrief.com), which turns a room
+// photo into a redesigned image plus a contractor-ready renovation brief.
+
+export const HOMEPAGE = "https://renobrief.com";
+
+// Baseline low/high cost per room (USD), assuming a standard-size room.
+export const ROOMS = {
+  bathroom: [5_000, 25_000],
+  kitchen: [12_000, 50_000],
+  bedroom: [2_000, 15_000],
+  living_room: [3_000, 20_000],
+  exterior: [5_000, 40_000],
+};
+
+// Finish-level multiplier. Quiet luxury runs the highest.
+export const STYLES = {
+  minimalist: 0.9,
+  farmhouse: 1.0,
+  modern: 1.1,
+  japandi: 1.15,
+  quiet_luxury: 1.4,
+};
+
+// How deep the work goes.
+export const SCOPES = {
+  refresh: 0.4, // paint, fixtures, styling
+  remodel: 1.0, // standard renovation
+  gut: 1.6, // down to the studs
+};
+
+/**
+ * Return a [low, high] budget range in USD.
+ * @param {string} room  one of ROOMS
+ * @param {object} [opts]
+ * @param {string} [opts.style="modern"]
+ * @param {string} [opts.scope="remodel"]
+ * @param {number} [opts.sqft]  optional room size, scaled vs ~120 sqft baseline
+ */
+export function estimate(room, { style = "modern", scope = "remodel", sqft } = {}) {
+  if (!(room in ROOMS)) {
+    throw new Error(`unknown room '${room}'; choose from ${Object.keys(ROOMS).join(", ")}`);
+  }
+  if (!(style in STYLES)) {
+    throw new Error(`unknown style '${style}'; choose from ${Object.keys(STYLES).join(", ")}`);
+  }
+  if (!(scope in SCOPES)) {
+    throw new Error(`unknown scope '${scope}'; choose from ${Object.keys(SCOPES).join(", ")}`);
+  }
+
+  const [low, high] = ROOMS[room];
+  let factor = STYLES[style] * SCOPES[scope];
+  if (sqft) factor *= Math.max(0.5, Number(sqft) / 120);
+
+  return [Math.round(low * factor), Math.round(high * factor)];
+}
+
+export default estimate;

package/package.json

@@ -0,0 +1,33 @@
+{
+  "name": "renobrief",
+  "version": "0.1.0",
+  "description": "Estimate home renovation budget ranges by room, style, and scope. Companion CLI for RenoBrief AI (https://renobrief.com).",
+  "keywords": [
+    "renovation",
+    "home-improvement",
+    "budget",
+    "remodel",
+    "interior-design",
+    "estimator"
+  ],
+  "homepage": "https://renobrief.com",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/wujieli0207/renobrief.git"
+  },
+  "license": "MIT",
+  "author": "wujieli",
+  "type": "module",
+  "main": "index.js",
+  "bin": {
+    "renobrief": "cli.js"
+  },
+  "files": [
+    "index.js",
+    "cli.js",
+    "README.md"
+  ],
+  "engines": {
+    "node": ">=16"
+  }
+}