Terminal Commands 🖥️

Word count

739 words

Reading time

5 minutes

Command-line tools

Usage Help

python cli.py --help

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

  CreatorBox CLI

Options:
  --help  Show this message and exit.

Commands:
  auth     Authentication
  install  Dependency installation  
  proxy    Proxy settings  
  start    Start service  
  update   Check for updates

Note

• After activating the virtual environment

conda activate creatorbox

Terminal Commands

1. Dependency Installation

• Optional

# elevenlabs
python cli.py install -f src/support/third_party/elevenlabs/requirements.txt
# cosyvoice
python cli.py install -f src/support/third_party/cosyvoice/requirements.txt
# f5_tts
python cli.py install -f src/support/third_party/f5_tts/requirements.txt
# coqui_tts
python cli.py install -f src/support/third_party/coqui_tts/requirements.txt

• Required

python cli.py install -f requirements.txt

Expected output:

Installing from requirements.txt...
Looking in indexes: https://pypi.tuna.tsinghua.edu.cn/simple/
Requirement already satisfied: torch==2.6.0 ...
...
✅ Installation complete.
Environment Info:
-  Platform                 : Windows
-  Python version           : 3.11.11
-  torch                    : 2.6.0
-  torchaudio               : 2.6.0
-  torchvision              : 0.21.0
-  numpy                    : 1.26.4
-  ...

Note

• When installing dependencies, execute in order: first the optional items, then the required items.

• If downloads are slow, modify the mirror source:

pip

pip config set install.trusted-host pypi.tuna.tsinghua.edu.cn
pip config set global.index-url https://pypi.tuna.tsinghua.edu.cn/simple/
pip config list

conda

conda config --add channels conda-forge
conda config --add channels https://mirrors.tuna.tsinghua.edu.cn/anaconda/pkgs/free/
conda config --add channels https://mirrors.tuna.tsinghua.edu.cn/anaconda/cloud/msys2/
conda config --show channels

2. Network Proxy

• Default

python cli.py proxy -h 127.0.0.1 -p 10808

• With authentication

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

• For a specific site

python 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

python cli.py start

• Specify host and port

python cli.py start -h 0.0.0.0 -p 80

• Enable intranet tunneling

python 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.17.eadcefb5

2025-08-23 18:51:07.416 | INFO  2612  main.py:127 - Build on master at 2025-08-23 18:42:57 started run successfully (8.02 seconds)
2025-08-23 18:51:08.322 | INFO  2612  proxy.py:91 - Proxy enabled and verified successfully.
2025-08-23 18:51:10.059 | INFO  2612  main.py:137 - Running on cpu device using Windows OS located in us.
2025-08-23 18:51:10.060 | INFO  2612  main.py:141 - Startup 2 job completed.
2025-08-23 18:51:10.060 | INFO  2612  main.py:142 - Startup 0 app completed.
2025-08-23 18:51:10.062 | INFO  2612  main.py:143 - http://172.18.0.1:8000

Note

• If you see RuntimeError: this license key is expired, try forcing an update:

python cli.py update --force

• If you see RuntimeError: [WinError 10060]...(1:11076), Please try restarting:

python cli.py start

• On Windows systems, simply double-click start.bat to run.

4. Check for Updates

• Default latest

python cli.py update

• Roll back to a version

python cli.py update -t 1.0.16

python cli.py update -c 788a0a42

• Force update

python cli.py update --force

Expected output:

⚠️ Force resetting to origin/master...
HEAD is now at 3fb781b6 更新文档

Authentication

1. Email Registration

• Random password

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

• Specified password

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

• Specified password + proxy

python 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. Login

• Default

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

• With proxy

python 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

3. Account

• Default

python cli.py auth -a user -e xiesx123@gmail.com

• With proxy

python cli.py auth -a user -e xiesx123@gmail.com --proxy

Expected output:

😊 Starting user -> xiesx123@gmail.com
✅ User successfully. uuid -> Q5tsyLZQtPMjOnSoK7chAdQVcdi2 (free)

4. Reset Password

• Default

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

• With proxy

python 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