Terminal Commands 🖥️

Word count

731 words

Reading time

5 minutes

Command-line tools

Usage Help

uv run cli.py --help

Usage: cli.py [OPTIONS] COMMAND [ARGS]...

  CreatorBox CLI

Options:
  --help  Show this message and exit.

Commands:
  auth     认证鉴权 Authentication
  install  扩展安装 Extension Installation
  proxy    网络代理 Proxy settings
  start    启动服务 Start service
  update   检查更新 Check for updates

Note

• After activating the environment

D: & cd "D:\Program Files\CreatorBox" & "D:\Program Files\CreatorBox\creatorbox\.venv\Scripts\activate"

Terminal Commands

1. Extension Installation

# iopaint
uv run cli.py install -n iopaint -p 8001 --start
# stable-diffusion-webui
uv run cli.py install -n stable-diffusion-webui -p 8002 --start
# cosyvoice
uv run cli.py install -n cosyvoice -p 8003 --start
# index_tts
uv run cli.py install -n index_tts -p 8004 --start
# gpt_sovits
uv run cli.py install -n gpt_sovits -p 8005 --start

Expected output:

Python 3.10.19
Using extensions/iopaint/.venv/scripts/python.exe
📦 Installing extension 'iopaint'...
Checked 106 packages in 2ms
All installed packages are compatible
Audited 24 packages in 7ms
✅ Installation complete.
🚀 Starting extension 'iopaint'...
extensions/iopaint/.venv/scripts/python.exe main.py start --config D:\Program Files\CreatorBox\creatorbox\webapp\extensions\iopaint\data\iopaint.json
2025-11-02 18:35:13.875 | INFO     | src.utils.cbinstaller:start:206 - ✅ iopaint 已启动（PID: 1904）
2025-11-02 18:35:14.182 | INFO     | iopaint.runtime:setup_model_dir:81 - Model directory: D:\Program Files\CreatorBox\creatorbox\models
...
2025-11-02 18:35:14.225 | INFO     | iopaint.cli:start:166 - Image will be saved to D:\Program Files\CreatorBox\creatorbox\webapp\extensions\iopaint\result
...
2025-11-02 18:35:17.419 | INFO     | iopaint.api:_build_file_manager:369 - Input is directory, initialize file manager D:\Program Files\CreatorBox\creatorbox\webapp\extensions\iopaint\picture
2025-11-02 18:35:17.428 | INFO     | iopaint.model_manager:init_model:47 - Loading model: lama
2025-11-02 18:35:17.430 | INFO     | iopaint.helper:load_jit_model:107 - Loading model from: D:\Program Files\CreatorBox\creatorbox\models\torch\hub\checkpoints\big-lama.pt
INFO:     Started server process [2588]
INFO:     Waiting for application startup.
INFO:     Application startup complete.
INFO:     Uvicorn running on http://0.0.0.0:8001 (Press CTRL+C to quit)

2. Network Proxy

• Default

uv run cli.py proxy -h 127.0.0.1 -p 10808

• With authentication

uv run cli.py proxy -h 127.0.0.1 -p 10810 -u admin -pwd 123456

• For a specific site

uv run cli.py proxy -h 127.0.0.1 -p 10810 -u admin -pwd 123456 -s https://www.youtube.com -t 5

Expected output:

🌐 Starting proxy verify. -> https://www.youtube.com
✅ Proxy verified successfully.

Tip

• Once verified, no need to enable v2rayN global mode.
• Any command-line tool that supports the --proxy option can use this parameter.

3. Start Service

• Default

uv run cli.py start

• Specify host and port

uv run cli.py start -h 0.0.0.0 -p 80

• Enable intranet tunneling

uv run cli.py start -h 0.0.0.0 -p 80 -nh toucan-real-informally.ngrok-free.app -np 80 --ngrok

Expected output:

✅ Ngrok tunnel started: NgrokTunnel: "https://toucan-real-informally.ngrok-free.app" -> "http://localhost:80"
🚀 Starting service... http://0.0.0.0:8000
   _____                _            ______
  /  __ \              | |           | ___ \
  | /  \/_ __ ___  __ _| |_ ___  _ __| |_/ / _____  __
  | |   | '__/ _ \/ _` | __/ _ \| '__| ___ \/ _ \ \/ /
  | \__/\ | |  __/ (_| | || (_) | |  | |_/ / (_) >  <
   \____/_|  \___|\__,_|\__\___/|_|  \____/ \___/_/\_\   v1.0.26.f83bdbff

2025-11-27 16:04:54.355 | INFO  2616  main.py:113 - Build on master at 2025-11-26 21:21:28 started run successfully (5.98 seconds)
2025-11-27 16:04:54.356 | INFO  2616  main.py:124 - Running on CPU device using Windows OS located in CN.
2025-11-27 16:04:54.356 | INFO  2616  main.py:126 - Running with Python 3.11.11 and Torch 2.6.0+cpu.
2025-11-27 16:04:54.357 | INFO  2616  main.py:128 - Startup 7 app completed.
2025-11-27 16:04:54.358 | INFO  2616  main.py:129 - http://127.0.0.1:8000

Note

Authentication

1. Email Registration

• Random password

uv run cli.py auth -a register -e xiesx123@gmail.com

• Specified password

uv run cli.py auth -a register -e xiesx123@gmail.com -p 123456

• Specified password + proxy

uv run cli.py auth -a register -e xiesx123@gmail.com -p 123456 --proxy

Expected output:

😊 Starting register -> xiesx123@gmail.com
✅ register successfully. please check your email to verify.

2. Reset Password

• Default

uv run cli.py auth -a resetpwd -e xiesx123@gmail.com

• With proxy

uv run cli.py auth -a resetpwd -e xiesx123@gmail.com --proxy

Expected output:

😊 Starting resetpwd -> xiesx123@gmail.com
✅ Resetpwd successfully. please check your email to reset your password.

Note

• The program does not store password information.
• During registration and password reset, emails are sent via Google Firebase.

Email Verification	Password Reset

3. Login

• Default

uv run cli.py auth -a login -e xiesx123@gmail.com -p 123456

• With proxy

uv run cli.py auth -a login -e xiesx123@gmail.com -p 123456 --proxy

Expected output:

😊 Starting login -> xiesx123@gmail.com
✅ Login successfully. token -> eyJhbGciOiJSUzI1NiIsImtpZCI6IjJiN2JhZ
hZmIyZjEwY2FlMmIxZjA3ZjM4MTZjNTQyMmJlY2NhNWMyMjMiLCJ0eXAiOiJKV1QifQXX
eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vdGVzdC1mOWQxMSIsI
CI6InRlc3QtZjlkMTEiLCJhdXRoX3RpbWUiOjE3NTUxNjE4NzEsInVzZXJfaWQiOiJYdj
dROUFpZnNUVUhuTXo2WmRIZWhvYndUb0czIiwic3ViIjoiWHY3UTlBaWZzVFVIbk16Nlp
....
kSGVob2J3VG9HMyIsImlhdCI6MTc1NTE2MTg3MSwiZXhwIjoxNzU1MTY1NDcxLCJlbWFp