@zktx.io/walrus-sites-preview 0.1.0 → 0.1.1

package/README.md

@@ -24,14 +24,24 @@ A short demo showing how to preview a deployed Walrus Site locally:
 
 https://github.com/user-attachments/assets/c28c033a-92c5-4ee9-82e0-1406319842c7
 
+The preview URL used in the demo is `http://localhost:3000`.
+
 ---
 
 ## Quickstart (one-liner)
 
-Preview a deployed Walrus Site in a single command:
+Preview a deployed Walrus Site in a single command.
+
+For mainnet:
 
 ```sh
-npx @zktx.io/walrus-sites-preview -testnet -id 0xYOUR_SITE_OBJECT_ID
+npx @zktx.io/walrus-sites-preview 0xYOUR_SITE_OBJECT_ID
+```
+
+For testnet:
+
+```sh
+npx @zktx.io/walrus-sites-preview -testnet 0xYOUR_SITE_OBJECT_ID
 ```
 
 Then open:
@@ -43,7 +53,7 @@ http://localhost:3000
 You can also add `--open` to open the browser automatically:
 
 ```sh
-npx @zktx.io/walrus-sites-preview -testnet -id 0xYOUR_SITE_OBJECT_ID --open
+npx @zktx.io/walrus-sites-preview 0xYOUR_SITE_OBJECT_ID --open
 ```
 
 ---
@@ -111,8 +121,8 @@ Add an npm script to your project so teammates can run a familiar command:
 ```json
 {
 	"scripts": {
-		"preview:testnet": "preview -testnet -id 0xYOUR_SITE_OBJECT_ID -port 3000",
-		"preview:mainnet": "preview -mainnet -id 0xYOUR_SITE_OBJECT_ID -port 3000"
+		"preview:testnet": "walrus-sites-preview -testnet 0xYOUR_SITE_OBJECT_ID -port 3000",
+		"preview:mainnet": "walrus-sites-preview 0xYOUR_SITE_OBJECT_ID -port 3000"
 	}
 }
 ```
@@ -181,6 +191,8 @@ When using `-testnet` or `-mainnet`, the following values are filled automatical
 - `aggregatorUrl`
 - `sitePackage`
 
+The positional one-liner defaults to mainnet. Pass `-testnet` for testnet sites.
+
 ### Supported fields
 
 - `siteObjectId` (required)
@@ -217,7 +229,7 @@ Add a pass-through script:
 ```json
 {
 	"scripts": {
-		"preview": "preview"
+		"preview": "walrus-sites-preview"
 	}
 }
 ```
@@ -225,7 +237,7 @@ Add a pass-through script:
 Then run:
 
 ```sh
-npm run preview -- -testnet -id 0xYOUR_SITE_OBJECT_ID -port 3000
+npm run preview -- -testnet 0xYOUR_SITE_OBJECT_ID -port 3000
 ```
 
 ---

package/package.json

@@ -1,10 +1,10 @@
 {
 	"name": "@zktx.io/walrus-sites-preview",
 	"description": "Local preview CLI for Walrus Sites (fetch from Sui + Walrus, or serve bundled static portal dist).",
-	"version": "0.1.0",
+	"version": "0.1.1",
 	"type": "module",
 	"bin": {
-		"preview": "preview.mjs"
+		"walrus-sites-preview": "preview.mjs"
 	},
 	"engines": {
 		"node": ">=18"
@@ -34,7 +34,7 @@
 		"cli"
 	],
 	"author": "daoauth",
-	"license": "ISC",
+	"license": "MIT",
 	"repository": {
 		"type": "git",
 		"url": "git+https://github.com/zktx-io/walrus-sites-preview.git"

package/preview.mjs

@@ -8,7 +8,7 @@ import childProcess from "node:child_process";
 const __filename = fileURLToPath(import.meta.url);
 const __dirname = path.dirname(__filename);
 
-const CLI_NAME = "preview";
+const CLI_NAME = "walrus-sites-preview";
 const defaultDistDir = path.resolve(__dirname, "./dist");
 
 const NETWORK_DEFAULTS = {
@@ -31,10 +31,12 @@ function usage() {
 		"Walrus Sites (standalone preview)",
 		"",
 		"Usage:",
+		`  ${CLI_NAME} <siteObjectId> [-testnet|-mainnet] [-port 3000] [--open]`,
 		`  ${CLI_NAME} [-testnet|-mainnet] -id <0x...> [-port 3000] [--open]`,
 		`  ${CLI_NAME} --mode static [--dist ./dist] [-port 3000] [--open]`,
 		"",
 		"Site mode options:",
+		"  <siteObjectId>             Site object ID; defaults to mainnet unless a network is set",
 		"  --config <path>            Path to config.json (default: ./config.json)",
 		"  -testnet / -mainnet        Apply built-in defaults (rpc/aggregator/sitePackage)",
 		"  -id, --id <0x...>          Site object ID",
@@ -55,6 +57,10 @@ function usage() {
 	].join("\n");
 }
 
+function isSuiObjectId(value) {
+	return /^0x[0-9a-fA-F]+$/.test(value);
+}
+
 function parsePort(value) {
 	const port = Number(value);
 	if (!Number.isInteger(port) || port <= 0 || port > 65535) {
@@ -75,6 +81,7 @@ function parseArgs(argv) {
 		aggregatorUrl: undefined,
 		sitePackage: undefined,
 		siteObjectId: undefined,
+		siteObjectIdFromPositional: false,
 		mainnet: false,
 		testnet: false,
 		open: false,
@@ -149,6 +156,14 @@ function parseArgs(argv) {
 			options.port = parsePort(takeValue());
 			continue;
 		}
+		if (!arg.startsWith("-") && isSuiObjectId(arg)) {
+			if (options.siteObjectId) {
+				throw new Error("Site object ID was provided more than once");
+			}
+			options.siteObjectId = arg;
+			options.siteObjectIdFromPositional = true;
+			continue;
+		}
 
 		unknown.push(arg);
 	}
@@ -318,7 +333,15 @@ function loadConfigFromFileAndCli() {
 }
 
 function applyNetworkDefaults(config) {
-	const which = cli.testnet ? "testnet" : cli.mainnet ? "mainnet" : null;
+	const configuredNetwork =
+		typeof config.network === "string" ? config.network.toLowerCase() : null;
+	const positionalDefault =
+		cli.siteObjectIdFromPositional && NETWORK_DEFAULTS[configuredNetwork]
+			? configuredNetwork
+			: cli.siteObjectIdFromPositional
+				? "mainnet"
+				: null;
+	const which = cli.testnet ? "testnet" : cli.mainnet ? "mainnet" : positionalDefault;
 	if (!which) return config;
 
 	const defaults = NETWORK_DEFAULTS[which];
@@ -681,7 +704,7 @@ if (mode === "static") {
 	if (missing.length) {
 		console.error(`Missing config fields for site mode: ${missing.join(", ")}`);
 		console.error(
-			`Pass CLI flags (e.g. \`${CLI_NAME} -testnet -id 0x...\`) or create ./config.json.`,
+			`Pass a site object ID (e.g. \`${CLI_NAME} 0x...\`), add network flags, or create ./config.json.`,
 		);
 		process.exit(1);
 	}