@hyper3d/cli 0.1.0-beta.2.1 → 0.1.0-beta.3.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +17 -2
- package/dist/index.js +9 -9
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -63,8 +63,17 @@ hyper3d generate --image ./reference.png
|
|
|
63
63
|
hyper3d generate --image ./front.png --image ./side.jpg --prompt "a ceramic teapot"
|
|
64
64
|
```
|
|
65
65
|
|
|
66
|
-
|
|
67
|
-
|
|
66
|
+
Provide a prompt, one to five images, or both. Generation options:
|
|
67
|
+
|
|
68
|
+
| Option | Accepted values | Default when omitted |
|
|
69
|
+
| ------------- | -------------------------------------------------------------- | ---------------------------- |
|
|
70
|
+
| `--tier` | `Gen-2.5-Medium`, `Gen-2.5-High`, `Gen-2.5-Extreme-Low` | `Gen-2.5-Medium` |
|
|
71
|
+
| `--mesh-mode` | `Raw`, `Quad` | `Raw` |
|
|
72
|
+
| `--format` | `glb`, `usdz`, `fbx`, `obj`, `stl` | `glb` |
|
|
73
|
+
| `--quality` | Target polygon count: Raw `500–1,000,000`; Quad `1,000–50,000` | Raw `500,000`; Quad `18,000` |
|
|
74
|
+
|
|
75
|
+
Defaults are applied by the server. The response includes a generation ID; use
|
|
76
|
+
it to check progress and retrieve the result:
|
|
68
77
|
|
|
69
78
|
```sh
|
|
70
79
|
hyper3d status <generation-id>
|
|
@@ -81,6 +90,12 @@ To separate a completed model into parts:
|
|
|
81
90
|
hyper3d bang <generation-id> --instruction "separate the handle and lid"
|
|
82
91
|
```
|
|
83
92
|
|
|
93
|
+
| Option | Meaning / accepted values | Default when omitted |
|
|
94
|
+
| --------------- | --------------------------------------------------------------------------------- | ------------------------ |
|
|
95
|
+
| `--instruction` | Description of the parts to separate | Automatic split planning |
|
|
96
|
+
| `--strength` | Integer `1–12`; soft target for the number of parts, so the actual count may vary | `5` |
|
|
97
|
+
| `--format` | `glb`, `usdz`, `fbx`, `obj`, `stl` | `glb` |
|
|
98
|
+
|
|
84
99
|
Run `hyper3d <command> --help` for more options. If a generation request times out,
|
|
85
100
|
check your existing tasks before submitting it again; the CLI never retries
|
|
86
101
|
billable generation automatically.
|
package/dist/index.js
CHANGED
|
@@ -58,12 +58,12 @@ authentication
|
|
|
58
58
|
cli
|
|
59
59
|
.command('generate')
|
|
60
60
|
.description('Generate a model from text and/or local reference images')
|
|
61
|
-
.option('--prompt <text>', 'Model description')
|
|
62
|
-
.option('--image <path>', 'Reference image; repeat for up to five images', (path, paths) => [...paths, path], [])
|
|
63
|
-
.option('--tier <tier>', 'Generation tier')
|
|
64
|
-
.option('--mesh-mode <mode>', 'Mesh mode,
|
|
65
|
-
.option('--format <format>', 'Geometry format,
|
|
66
|
-
.option('--quality <count>', 'Target polygon count', Number)
|
|
61
|
+
.option('--prompt <text>', 'Model description; required without --image')
|
|
62
|
+
.option('--image <path>', 'Reference image; repeat for up to five images; required without --prompt', (path, paths) => [...paths, path], [])
|
|
63
|
+
.option('--tier <tier>', 'Generation tier: Gen-2.5-Medium, Gen-2.5-High, Gen-2.5-Extreme-Low (server default: Gen-2.5-Medium)')
|
|
64
|
+
.option('--mesh-mode <mode>', 'Mesh mode: Raw, Quad (server default: Raw)')
|
|
65
|
+
.option('--format <format>', 'Geometry format: glb, usdz, fbx, obj, stl (server default: glb)')
|
|
66
|
+
.option('--quality <count>', 'Target polygon count: Raw 500-1,000,000, Quad 1,000-50,000 (server default: Raw 500,000, Quad 18,000)', Number)
|
|
67
67
|
.action(async (options) => print(await generate(options)));
|
|
68
68
|
// poll
|
|
69
69
|
for (const [command, action] of [
|
|
@@ -83,9 +83,9 @@ cli
|
|
|
83
83
|
cli
|
|
84
84
|
.command('bang <generation-id>')
|
|
85
85
|
.description('Run BANG to separate a completed model into parts')
|
|
86
|
-
.option('--instruction <text>', 'Parts to separate')
|
|
87
|
-
.option('--strength <count>', '
|
|
88
|
-
.option('--format <format>', 'Geometry format')
|
|
86
|
+
.option('--instruction <text>', 'Parts to separate; omit for automatic split planning')
|
|
87
|
+
.option('--strength <count>', 'Soft target part count, 1-12; actual count may vary (server default: 5)', Number)
|
|
88
|
+
.option('--format <format>', 'Geometry format: glb, usdz, fbx, obj, stl (server default: glb)')
|
|
89
89
|
.action(async (id, options) => print(await bang(id, options)));
|
|
90
90
|
// update
|
|
91
91
|
cli
|
package/dist/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AACA,OAAO,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAC5C,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAEzC,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAC;AAE5C,OAAO,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AAC3C,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,WAAW,CAAC;AAC1C,OAAO,EACL,gBAAgB,EAChB,kBAAkB,EAClB,SAAS,GACV,MAAM,gBAAgB,CAAC;AACxB,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,iBAAiB,CAAC;AACvE,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAC3C,OAAO,EAAE,WAAW,EAAE,MAAM,EAAE,aAAa,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAChF,OAAO,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAI1C,MAAM,GAAG,GAAG,IAAI,CAAC,KAAK,CACpB,MAAM,QAAQ,CAAC,IAAI,GAAG,CAAC,iBAAiB,EAAE,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,MAAM,CAAC,CACpE,CAAC;AAEF,MAAM,KAAK,GAAG,CAAC,KAAc,EAAE,IAAa,EAAE,EAAE;IAC9C,OAAO,CAAC,MAAM,CAAC,KAAK,CAClB,GAAG,YAAY,CAAC,KAAK,EAAE,EAAE,MAAM,EAAE,GAAG,CAAC,IAAI,EAAE,CAAC,MAAM,EAAE,IAAI,EAAE,CAAC,IAAI,CAChE,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,GAAG,GAAG,IAAI,OAAO,CAAC,SAAS,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;AACxD,GAAG,CAAC,MAAM,CACR,kBAAkB,EAClB,2CAA2C,EAC3C,OAAO,CAAC,GAAG,CAAC,QAAQ,IAAI,gBAAgB,CACzC,CAAC;AACF,GAAG,CAAC,SAAS,CACX,IAAI,MAAM,CAAC,mBAAmB,EAAE,eAAe,CAAC;KAC7C,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;KAC1B,OAAO,CAAC,OAAO,CAAC,CACpB,CAAC;AAEF,GAAG,CAAC,IAAI,CAAC,WAAW,EAAE,GAAG,EAAE;IACzB,kBAAkB,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC,OAAO,CAAC,CAAC;AACzC,CAAC,CAAC,CAAC;AAEH,GAAG,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE;IAC7C,IACE,OAAO,CAAC,MAAM,KAAK,GAAG;QACtB,CAAC,CAAC,UAAU,EAAE,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC;QAE1E,OAAO;IACT,IACE,OAAO,CAAC,GAAG,CAAC,EAAE;QACd,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK;QACrB,OAAO,CAAC,GAAG,CAAC,oBAAoB,KAAK,GAAG;QAExC,OAAO;IAET,MAAM,OAAO,GAAG,MAAM,aAAa,CAAC,GAAG,EAAE;QACvC,UAAU,EAAE,OAAO,CAAC,GAAG,CAAC,mBAAmB,KAAK,GAAG;QACnD,QAAQ,EAAE,YAAY,EAAE;KACzB,CAAC,CAAC;IACH,IAAI,OAAO;QAAE,MAAM,IAAI,KAAK,CAAC,kCAAkC,CAAC,CAAC;AACnE,CAAC,CAAC,CAAC;AAEH,OAAO;AACP,MAAM,cAAc,GAAG,GAAG,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;AAC3C,cAAc;KACX,OAAO,CAAC,OAAO,CAAC;KAChB,MAAM,CACL,cAAc,EACd,gEAAgE,CACjE;KACA,MAAM,CAAC,KAAK,EAAE,OAAO,EAAE,EAAE;IACxB,MAAM,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC;IACzD,KAAK,CAAC,EAAE,aAAa,EAAE,IAAI,EAAE,EAAE,YAAY,CAAC,CAAC;AAC/C,CAAC,CAAC,CAAC;AACL,cAAc,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,KAAK,IAAI,EAAE;IACjD,MAAM,MAAM,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;IAC5B,KAAK,CAAC,EAAE,uBAAuB,EAAE,IAAI,EAAE,EAAE,aAAa,CAAC,CAAC;AAC1D,CAAC,CAAC,CAAC;AAEH,cAAc;KACX,OAAO,CAAC,QAAQ,CAAC;KACjB,KAAK,CAAC,MAAM,CAAC;KACb,WAAW,CAAC,yDAAyD,CAAC;KACtE,MAAM,CAAC,KAAK,IAAI,EAAE,CAAC,KAAK,CAAC,MAAM,WAAW,EAAE,EAAE,SAAS,CAAC,CAAC,CAAC;AAE7D,WAAW;AACX,GAAG;KACA,OAAO,CAAC,UAAU,CAAC;KACnB,WAAW,CAAC,0DAA0D,CAAC;KACvE,MAAM,CAAC,iBAAiB,EAAE,
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AACA,OAAO,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAC5C,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAEzC,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAC;AAE5C,OAAO,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AAC3C,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,WAAW,CAAC;AAC1C,OAAO,EACL,gBAAgB,EAChB,kBAAkB,EAClB,SAAS,GACV,MAAM,gBAAgB,CAAC;AACxB,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,iBAAiB,CAAC;AACvE,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAC3C,OAAO,EAAE,WAAW,EAAE,MAAM,EAAE,aAAa,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAChF,OAAO,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAI1C,MAAM,GAAG,GAAG,IAAI,CAAC,KAAK,CACpB,MAAM,QAAQ,CAAC,IAAI,GAAG,CAAC,iBAAiB,EAAE,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,MAAM,CAAC,CACpE,CAAC;AAEF,MAAM,KAAK,GAAG,CAAC,KAAc,EAAE,IAAa,EAAE,EAAE;IAC9C,OAAO,CAAC,MAAM,CAAC,KAAK,CAClB,GAAG,YAAY,CAAC,KAAK,EAAE,EAAE,MAAM,EAAE,GAAG,CAAC,IAAI,EAAE,CAAC,MAAM,EAAE,IAAI,EAAE,CAAC,IAAI,CAChE,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,GAAG,GAAG,IAAI,OAAO,CAAC,SAAS,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;AACxD,GAAG,CAAC,MAAM,CACR,kBAAkB,EAClB,2CAA2C,EAC3C,OAAO,CAAC,GAAG,CAAC,QAAQ,IAAI,gBAAgB,CACzC,CAAC;AACF,GAAG,CAAC,SAAS,CACX,IAAI,MAAM,CAAC,mBAAmB,EAAE,eAAe,CAAC;KAC7C,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;KAC1B,OAAO,CAAC,OAAO,CAAC,CACpB,CAAC;AAEF,GAAG,CAAC,IAAI,CAAC,WAAW,EAAE,GAAG,EAAE;IACzB,kBAAkB,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC,OAAO,CAAC,CAAC;AACzC,CAAC,CAAC,CAAC;AAEH,GAAG,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE;IAC7C,IACE,OAAO,CAAC,MAAM,KAAK,GAAG;QACtB,CAAC,CAAC,UAAU,EAAE,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC;QAE1E,OAAO;IACT,IACE,OAAO,CAAC,GAAG,CAAC,EAAE;QACd,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK;QACrB,OAAO,CAAC,GAAG,CAAC,oBAAoB,KAAK,GAAG;QAExC,OAAO;IAET,MAAM,OAAO,GAAG,MAAM,aAAa,CAAC,GAAG,EAAE;QACvC,UAAU,EAAE,OAAO,CAAC,GAAG,CAAC,mBAAmB,KAAK,GAAG;QACnD,QAAQ,EAAE,YAAY,EAAE;KACzB,CAAC,CAAC;IACH,IAAI,OAAO;QAAE,MAAM,IAAI,KAAK,CAAC,kCAAkC,CAAC,CAAC;AACnE,CAAC,CAAC,CAAC;AAEH,OAAO;AACP,MAAM,cAAc,GAAG,GAAG,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;AAC3C,cAAc;KACX,OAAO,CAAC,OAAO,CAAC;KAChB,MAAM,CACL,cAAc,EACd,gEAAgE,CACjE;KACA,MAAM,CAAC,KAAK,EAAE,OAAO,EAAE,EAAE;IACxB,MAAM,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC;IACzD,KAAK,CAAC,EAAE,aAAa,EAAE,IAAI,EAAE,EAAE,YAAY,CAAC,CAAC;AAC/C,CAAC,CAAC,CAAC;AACL,cAAc,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,KAAK,IAAI,EAAE;IACjD,MAAM,MAAM,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;IAC5B,KAAK,CAAC,EAAE,uBAAuB,EAAE,IAAI,EAAE,EAAE,aAAa,CAAC,CAAC;AAC1D,CAAC,CAAC,CAAC;AAEH,cAAc;KACX,OAAO,CAAC,QAAQ,CAAC;KACjB,KAAK,CAAC,MAAM,CAAC;KACb,WAAW,CAAC,yDAAyD,CAAC;KACtE,MAAM,CAAC,KAAK,IAAI,EAAE,CAAC,KAAK,CAAC,MAAM,WAAW,EAAE,EAAE,SAAS,CAAC,CAAC,CAAC;AAE7D,WAAW;AACX,GAAG;KACA,OAAO,CAAC,UAAU,CAAC;KACnB,WAAW,CAAC,0DAA0D,CAAC;KACvE,MAAM,CAAC,iBAAiB,EAAE,6CAA6C,CAAC;KACxE,MAAM,CACL,gBAAgB,EAChB,0EAA0E,EAC1E,CAAC,IAAY,EAAE,KAAe,EAAE,EAAE,CAAC,CAAC,GAAG,KAAK,EAAE,IAAI,CAAC,EACnD,EAAE,CACH;KACA,MAAM,CACL,eAAe,EACf,qGAAqG,CACtG;KACA,MAAM,CAAC,oBAAoB,EAAE,4CAA4C,CAAC;KAC1E,MAAM,CACL,mBAAmB,EACnB,iEAAiE,CAClE;KACA,MAAM,CACL,mBAAmB,EACnB,uGAAuG,EACvG,MAAM,CACP;KACA,MAAM,CAAC,KAAK,EAAE,OAAO,EAAE,EAAE,CAAC,KAAK,CAAC,MAAM,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;AAE7D,OAAO;AACP,KAAK,MAAM,CAAC,OAAO,EAAE,MAAM,CAAC,IAAI;IAC9B,CAAC,QAAQ,EAAE,MAAM,CAAC;IAClB,CAAC,QAAQ,EAAE,MAAM,CAAC;CACV,EAAE,CAAC;IACX,GAAG;SACA,OAAO,CAAC,GAAG,OAAO,kBAAkB,CAAC;SACrC,MAAM,CAAC,KAAK,EAAE,EAAE,EAAE,EAAE,CAAC,KAAK,CAAC,MAAM,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;AACnD,CAAC;AAED,GAAG;KACA,OAAO,CAAC,sBAAsB,CAAC;KAC/B,WAAW,CAAC,uDAAuD,CAAC;KACpE,MAAM,CAAC,qBAAqB,EAAE,kCAAkC,EAAE,MAAM,EAAE,EAAE,CAAC;KAC7E,MAAM,CAAC,KAAK,EAAE,EAAE,EAAE,OAAO,EAAE,EAAE,CAAC,KAAK,CAAC,MAAM,IAAI,CAAC,EAAE,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;AAEzE,OAAO;AACP,GAAG;KACA,OAAO,CAAC,sBAAsB,CAAC;KAC/B,WAAW,CAAC,mDAAmD,CAAC;KAChE,MAAM,CACL,sBAAsB,EACtB,sDAAsD,CACvD;KACA,MAAM,CACL,oBAAoB,EACpB,yEAAyE,EACzE,MAAM,CACP;KACA,MAAM,CACL,mBAAmB,EACnB,iEAAiE,CAClE;KACA,MAAM,CAAC,KAAK,EAAE,EAAE,EAAE,OAAO,EAAE,EAAE,CAAC,KAAK,CAAC,MAAM,IAAI,CAAC,EAAE,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC;AAEjE,SAAS;AACT,GAAG;KACA,OAAO,CAAC,QAAQ,CAAC;KACjB,MAAM,CAAC,SAAS,EAAE,gBAAgB,CAAC;KACnC,MAAM,CAAC,qBAAqB,EAAE,sBAAsB,EAAE,aAAa,CAAC,GAAG,CAAC,CAAC;KACzE,MAAM,CAAC,KAAK,EAAE,OAAO,EAAE,EAAE,CACxB,KAAK,CACH,OAAO,CAAC,KAAK;IACX,CAAC,CAAC,MAAM,WAAW,CAAC,GAAG,EAAE,OAAO,CAAC,OAAO,CAAC;IACzC,CAAC,CAAC,MAAM,MAAM,CACV,GAAG,EACH,aAAa,CAAC,IAAI,GAAG,CAAC,IAAI,EAAE,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,EAC7C,OAAO,CAAC,OAAO,CAChB,CACN,CACF,CAAC;AAEJ,IAAI,CAAC;IACH,MAAM,GAAG,CAAC,UAAU,EAAE,CAAC;AACzB,CAAC;AAAC,OAAO,KAAK,EAAE,CAAC;IACf,MAAM,OAAO,GAAG,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,gBAAgB,CAAC;IAC1E,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,UAAU,OAAO,IAAI,CAAC,CAAC;IAC5C,OAAO,CAAC,QAAQ,GAAG,CAAC,CAAC;AACvB,CAAC"}
|