@volcengine/s3d-cli 0.0.0-stage → 0.1.0
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/LICENSE +202 -0
- package/README.md +89 -2
- package/THIRD_PARTY_NOTICES.txt +1025 -0
- package/Third-party software notice.json +39 -0
- package/bin/s3dcli.cjs +66 -0
- package/manifest.json +24 -0
- package/native/s3dcli-darwin-amd64 +0 -0
- package/native/s3dcli-darwin-arm64 +0 -0
- package/native/s3dcli-linux-amd64 +0 -0
- package/native/s3dcli-linux-arm64 +0 -0
- package/native/s3dcli-windows-amd64.exe +0 -0
- package/native/s3dcli-windows-arm64.exe +0 -0
- package/package.json +32 -4
package/LICENSE
ADDED
|
@@ -0,0 +1,202 @@
|
|
|
1
|
+
|
|
2
|
+
Apache License
|
|
3
|
+
Version 2.0, January 2004
|
|
4
|
+
http://www.apache.org/licenses/
|
|
5
|
+
|
|
6
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
7
|
+
|
|
8
|
+
1. Definitions.
|
|
9
|
+
|
|
10
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
11
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
12
|
+
|
|
13
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
14
|
+
the copyright owner that is granting the License.
|
|
15
|
+
|
|
16
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
17
|
+
other entities that control, are controlled by, or are under common
|
|
18
|
+
control with that entity. For the purposes of this definition,
|
|
19
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
20
|
+
direction or management of such entity, whether by contract or
|
|
21
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
22
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
23
|
+
|
|
24
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
25
|
+
exercising permissions granted by this License.
|
|
26
|
+
|
|
27
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
28
|
+
including but not limited to software source code, documentation
|
|
29
|
+
source, and configuration files.
|
|
30
|
+
|
|
31
|
+
"Object" form shall mean any form resulting from mechanical
|
|
32
|
+
transformation or translation of a Source form, including but
|
|
33
|
+
not limited to compiled object code, generated documentation,
|
|
34
|
+
and conversions to other media types.
|
|
35
|
+
|
|
36
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
37
|
+
Object form, made available under the License, as indicated by a
|
|
38
|
+
copyright notice that is included in or attached to the work
|
|
39
|
+
(an example is provided in the Appendix below).
|
|
40
|
+
|
|
41
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
42
|
+
form, that is based on (or derived from) the Work and for which the
|
|
43
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
44
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
45
|
+
of this License, Derivative Works shall not include works that remain
|
|
46
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
47
|
+
the Work and Derivative Works thereof.
|
|
48
|
+
|
|
49
|
+
"Contribution" shall mean any work of authorship, including
|
|
50
|
+
the original version of the Work and any modifications or additions
|
|
51
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
52
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
53
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
54
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
55
|
+
means any form of electronic, verbal, or written communication sent
|
|
56
|
+
to the Licensor or its representatives, including but not limited to
|
|
57
|
+
communication on electronic mailing lists, source code control systems,
|
|
58
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
59
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
60
|
+
excluding communication that is conspicuously marked or otherwise
|
|
61
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
62
|
+
|
|
63
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
64
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
65
|
+
subsequently incorporated within the Work.
|
|
66
|
+
|
|
67
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
68
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
69
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
70
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
71
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
72
|
+
Work and such Derivative Works in Source or Object form.
|
|
73
|
+
|
|
74
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
75
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
76
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
77
|
+
(except as stated in this section) patent license to make, have made,
|
|
78
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
79
|
+
where such license applies only to those patent claims licensable
|
|
80
|
+
by such Contributor that are necessarily infringed by their
|
|
81
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
82
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
83
|
+
institute patent litigation against any entity (including a
|
|
84
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
85
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
86
|
+
or contributory patent infringement, then any patent licenses
|
|
87
|
+
granted to You under this License for that Work shall terminate
|
|
88
|
+
as of the date such litigation is filed.
|
|
89
|
+
|
|
90
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
91
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
92
|
+
modifications, and in Source or Object form, provided that You
|
|
93
|
+
meet the following conditions:
|
|
94
|
+
|
|
95
|
+
(a) You must give any other recipients of the Work or
|
|
96
|
+
Derivative Works a copy of this License; and
|
|
97
|
+
|
|
98
|
+
(b) You must cause any modified files to carry prominent notices
|
|
99
|
+
stating that You changed the files; and
|
|
100
|
+
|
|
101
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
102
|
+
that You distribute, all copyright, patent, trademark, and
|
|
103
|
+
attribution notices from the Source form of the Work,
|
|
104
|
+
excluding those notices that do not pertain to any part of
|
|
105
|
+
the Derivative Works; and
|
|
106
|
+
|
|
107
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
108
|
+
distribution, then any Derivative Works that You distribute must
|
|
109
|
+
include a readable copy of the attribution notices contained
|
|
110
|
+
within such NOTICE file, excluding those notices that do not
|
|
111
|
+
pertain to any part of the Derivative Works, in at least one
|
|
112
|
+
of the following places: within a NOTICE text file distributed
|
|
113
|
+
as part of the Derivative Works; within the Source form or
|
|
114
|
+
documentation, if provided along with the Derivative Works; or,
|
|
115
|
+
within a display generated by the Derivative Works, if and
|
|
116
|
+
wherever such third-party notices normally appear. The contents
|
|
117
|
+
of the NOTICE file are for informational purposes only and
|
|
118
|
+
do not modify the License. You may add Your own attribution
|
|
119
|
+
notices within Derivative Works that You distribute, alongside
|
|
120
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
121
|
+
that such additional attribution notices cannot be construed
|
|
122
|
+
as modifying the License.
|
|
123
|
+
|
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
|
125
|
+
may provide additional or different license terms and conditions
|
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
129
|
+
the conditions stated in this License.
|
|
130
|
+
|
|
131
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
132
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
133
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
134
|
+
this License, without any additional terms or conditions.
|
|
135
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
136
|
+
the terms of any separate license agreement you may have executed
|
|
137
|
+
with Licensor regarding such Contributions.
|
|
138
|
+
|
|
139
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
140
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
141
|
+
except as required for reasonable and customary use in describing the
|
|
142
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
143
|
+
|
|
144
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
145
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
146
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
147
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
148
|
+
implied, including, without limitation, any warranties or conditions
|
|
149
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
150
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
|
152
|
+
risks associated with Your exercise of permissions under this License.
|
|
153
|
+
|
|
154
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
155
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
156
|
+
unless required by applicable law (such as deliberate and grossly
|
|
157
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
158
|
+
liable to You for damages, including any direct, indirect, special,
|
|
159
|
+
incidental, or consequential damages of any character arising as a
|
|
160
|
+
result of this License or out of the use or inability to use the
|
|
161
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
163
|
+
other commercial damages or losses), even if such Contributor
|
|
164
|
+
has been advised of the possibility of such damages.
|
|
165
|
+
|
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
167
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
169
|
+
or other liability obligations and/or rights consistent with this
|
|
170
|
+
License. However, in accepting such obligations, You may act only
|
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
175
|
+
of your accepting any such warranty or additional liability.
|
|
176
|
+
|
|
177
|
+
END OF TERMS AND CONDITIONS
|
|
178
|
+
|
|
179
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
180
|
+
|
|
181
|
+
To apply the Apache License to your work, attach the following
|
|
182
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
183
|
+
replaced with your own identifying information. (Don't include
|
|
184
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
185
|
+
comment syntax for the file format. We also recommend that a
|
|
186
|
+
file or class name and description of purpose be included on the
|
|
187
|
+
same "printed page" as the copyright notice for easier
|
|
188
|
+
identification within third-party archives.
|
|
189
|
+
|
|
190
|
+
Copyright [yyyy] [name of copyright owner]
|
|
191
|
+
|
|
192
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
193
|
+
you may not use this file except in compliance with the License.
|
|
194
|
+
You may obtain a copy of the License at
|
|
195
|
+
|
|
196
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
197
|
+
|
|
198
|
+
Unless required by applicable law or agreed to in writing, software
|
|
199
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
200
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
201
|
+
See the License for the specific language governing permissions and
|
|
202
|
+
limitations under the License.
|
package/README.md
CHANGED
|
@@ -1,3 +1,90 @@
|
|
|
1
|
-
#
|
|
1
|
+
# s3dcli
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
s3dcli 是 Seed3D 的命令行工具,支持火山引擎账号登录、TOS 文件上传、图片与 3D 生成、资产查询和下载,以及 SimReady 资产构建。
|
|
4
|
+
|
|
5
|
+
## 安装
|
|
6
|
+
|
|
7
|
+
需要 Node.js 20 或更新版本。支持 macOS、Linux、Windows 的 x64/arm64。
|
|
8
|
+
安装包自带原生二进制,无需安装 Go,安装期间不下载额外二进制或执行登录。
|
|
9
|
+
|
|
10
|
+
```sh
|
|
11
|
+
npm install -g @volcengine/s3d-cli@latest --registry=https://registry.npmjs.org/
|
|
12
|
+
s3dcli --version
|
|
13
|
+
s3dcli --help
|
|
14
|
+
```
|
|
15
|
+
|
|
16
|
+
也可安装提供的发布包:`npm install -g ./volcengine-s3d-cli-0.1.0.tgz`。
|
|
17
|
+
|
|
18
|
+
## 登录与模型开通
|
|
19
|
+
|
|
20
|
+
```sh
|
|
21
|
+
s3dcli auth login
|
|
22
|
+
s3dcli auth status
|
|
23
|
+
s3dcli auth verify
|
|
24
|
+
s3dcli models list
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
使用具备对应服务访问权限的火山引擎账号。`auth status` 仅查看本地登录状态,`auth verify` 在线验证访问状态。
|
|
28
|
+
需要开通生成模型时执行 `s3dcli models activate`,随后用 `models list` 检查每项模型的状态;命令成功不代表所有模型已就绪。
|
|
29
|
+
生成、模型服务和存储操作可能产生费用,请先确认对应服务的计费规则和账号权限。
|
|
30
|
+
|
|
31
|
+
无法自动打开浏览器时,执行 `s3dcli auth login --no-browser` 获取授权链接,在浏览器完成授权后执行:
|
|
32
|
+
|
|
33
|
+
```sh
|
|
34
|
+
s3dcli auth login --no-browser --code '<browser-code>'
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
登录态保存在 `~/.s3dcli`。`s3dcli auth logout` 清理本地凭证;npm 升级或卸载不会删除该目录。不要分享凭证文件、授权码或令牌。
|
|
38
|
+
|
|
39
|
+
## 从文本生成 3D
|
|
40
|
+
|
|
41
|
+
创建 `text-to-3d.json`,将 `model_id` 替换为账号可用的生图模型 ID:
|
|
42
|
+
|
|
43
|
+
```json
|
|
44
|
+
{"schema_version":"studio.text-to-3d/v1","prompt":"一把木质餐椅,完整主体,白色背景","image":{"model_id":"<生图模型 ID>"},"model":{"face_level":"medium"}}
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
```sh
|
|
48
|
+
s3dcli +text-to-3d --input @text-to-3d.json --timeout 20m
|
|
49
|
+
s3dcli +text-to-3d --resume RUN_ID
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
该命令先生成图片,再生成 3D,默认等待最终结果。恢复可能继续提交下一计费阶段;只想查询已有任务时使用 `s3dcli task show`。提交结果未知时不要重复创建任务。
|
|
53
|
+
|
|
54
|
+
其他生成、资产和 SimReady 命令可通过 `s3dcli image --help`、`s3dcli 3d --help`、`s3dcli asset --help` 和 `s3dcli simready --help` 查看。具体能力取决于账号权限及服务可用性。
|
|
55
|
+
|
|
56
|
+
## 上传到 TOS
|
|
57
|
+
|
|
58
|
+
```sh
|
|
59
|
+
s3dcli tos bucket list --region cn-beijing
|
|
60
|
+
s3dcli tos upload ./model.glb --bucket <bucket> --region cn-beijing --dry-run
|
|
61
|
+
s3dcli tos upload ./model.glb --bucket <bucket> --region cn-beijing
|
|
62
|
+
```
|
|
63
|
+
|
|
64
|
+
目标 bucket 必须已存在且账号具备写入权限。默认以文件名作为 object key,可用 `--key` 指定;仅在需要覆盖时使用 `--overwrite`。
|
|
65
|
+
支持单个普通文件,最大 5 GiB;不支持递归上传、分片续传或自动建桶。
|
|
66
|
+
`--dry-run` 是离线预览,不验证账号权限或资源是否存在。返回的 TOS URI 不等于公开下载链接。
|
|
67
|
+
|
|
68
|
+
## 安装 Agent Skill
|
|
69
|
+
|
|
70
|
+
```sh
|
|
71
|
+
s3dcli +connect list
|
|
72
|
+
s3dcli +connect --agent codex --dry-run
|
|
73
|
+
s3dcli +connect --agent codex
|
|
74
|
+
```
|
|
75
|
+
|
|
76
|
+
支持 Codex、Claude Code、Cursor、OpenCode,也可使用 `--path SKILLS_DIR` 指定安装目录。
|
|
77
|
+
Skill 随 CLI 内嵌分发,版本与 CLI 一致;升级 CLI 后重新执行 `+connect` 并重载 Agent。
|
|
78
|
+
安装会保留用户修改过或归属未知的文件,冲突时请检查命令输出。
|
|
79
|
+
|
|
80
|
+
## 完整性与问题排查
|
|
81
|
+
|
|
82
|
+
每次启动会校验包内二进制的 SHA-256,校验失败请重新安装。
|
|
83
|
+
排查问题时记录 CLI 版本、操作系统、执行命令和脱敏后的错误信息;不要附带凭证或签名下载链接。
|
|
84
|
+
|
|
85
|
+
## License
|
|
86
|
+
|
|
87
|
+
Copyright (c) 2026 Beijing Volcano Engine Technology Co., Ltd.
|
|
88
|
+
|
|
89
|
+
本软件(含启动器及随包 Skill 文本)采用 Apache License 2.0,完整许可证见 [LICENSE](LICENSE)。
|
|
90
|
+
第三方组件遵循各自的许可证:组件清单见 `Third-party software notice.json`,完整版权及许可文本见 `THIRD_PARTY_NOTICES.txt`。
|