Terminal Commands 🖥️
Command-line tools
Usage Help
bash
python cli.py --help
bash
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
Terminal Commands
1. Dependency Installation
- Optional
bash
# 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
bash
python cli.py install -f requirements.txt
Expected output:
log
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
- Dependencies must be installed in order — run optional items first, then required items.
- If download speed is slow, switch to a mirror source.
pip
bash
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
bash
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
bash
python cli.py proxy -h 127.0.0.1 -p 10808
- With authentication
bash
python cli.py proxy -h 127.0.0.1 -p 10810 -u admin -pwd 123456
- For a specific site
bash
python cli.py proxy -h 127.0.0.1 -p 10810 -u admin -pwd 123456 -s https://www.youtube.com -t 5
Expected output:
log
🌐 Starting proxy verify. -> https://www.youtube.com
✅ Proxy verified successfully.
Tip
- Once verified, no need to enable
v2rayN global mode
. - The same configuration works with the
--proxy
parameter for other CLI tools.
3. Start Service
- Default
bash
python cli.py start
- Specify host and port
bash
python cli.py start -h 0.0.0.0 -p 80
- Enable intranet tunneling
bash
python cli.py start -h 0.0.0.0 -p 80 -nh toucan-real-informally.ngrok-free.app -np 80 --ngrok
Expected output:
log
✅ Ngrok tunnel started: NgrokTunnel: "https://toucan-real-informally.ngrok-free.app" -> "http://localhost:80"
🚀 Starting service... http://0.0.0.0:80
_____ _ ______
/ __ \ | | | ___ \
| / \/_ __ ___ __ _| |_ ___ _ __| |_/ / _____ __
| | | '__/ _ \/ _` | __/ _ \| '__| ___ \/ _ \ \/ /
| \__/\ | | __/ (_| | || (_) | | | |_/ / (_) > <
\____/_| \___|\__,_|\__\___/|_| \____/ \___/_/\_\ v1.0.16.654c4d3a
2025-08-14 22:35:18.134 | INFO 3144 main.py:122 - Build on master at 2025-08-12 15:11:54 started run successfully (14.42 seconds)
2025-08-14 22:35:19.216 | INFO 3144 main.py:166 - Proxy enabled and verified successfully.
2025-08-14 22:35:19.223 | INFO 3144 main.py:134 - Startup scheduler 2 job completed.
2025-08-14 22:35:19.223 | INFO 3144 main.py:135 - Startup gradio 0 app completed.
2025-08-14 22:35:19.226 | INFO 3144 main.py:136 - http://192.168.0.100:80
Note
- On Windows systems, simply double-click
start.bat
to run. - If you see
RuntimeError: this license key is expired
, try forcing an update:
bash
python cli.py update --force
4. Check for Updates
- Default latest
bash
python cli.py update
- Roll back to a version
bash
python cli.py update -t 1.0.16
bash
python cli.py update -c 788a0a42
- Force update
bash
python cli.py update --force
Expected output:
log
⚠️ Force resetting to origin/master...
HEAD is now at 3fb781b6 更新文档
Authentication
1. Email Registration
- Random password
bash
python cli.py auth -a register -e xiesx123@gmail.com
- Specified password
bash
python cli.py auth -a register -e xiesx123@gmail.com -p 123456
- Specified password + proxy
bash
python cli.py auth -a register -e xiesx123@gmail.com -p 123456 --proxy
Expected output:
log
😊 Starting register -> xiesx123@gmail.com
✅ register successfully. please check your email to verify.
2. Login
- Default
bash
python cli.py auth -a login -e xiesx123@gmail.com -p 123456
- With proxy
bash
python cli.py auth -a login -e xiesx123@gmail.com -p 123456 --proxy
Expected output:
log
😊 Starting login -> xiesx123@gmail.com
✅ Login successfully. token -> eyJhbGciOiJSUzI1NiIsImtpZCI6IjJiN2JhZ
hZmIyZjEwY2FlMmIxZjA3ZjM4MTZjNTQyMmJlY2NhNWMyMjMiLCJ0eXAiOiJKV1QifQXX
eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vdGVzdC1mOWQxMSIsI
CI6InRlc3QtZjlkMTEiLCJhdXRoX3RpbWUiOjE3NTUxNjE4NzEsInVzZXJfaWQiOiJYdj
dROUFpZnNUVUhuTXo2WmRIZWhvYndUb0czIiwic3ViIjoiWHY3UTlBaWZzVFVIbk16Nlp
....
kSGVob2J3VG9HMyIsImlhdCI6MTc1NTE2MTg3MSwiZXhwIjoxNzU1MTY1NDcxLCJlbWFp
3. Account
- Default
bash
python cli.py auth -a user -e xiesx123@gmail.com
- With proxy
bash
python cli.py auth -a user -e xiesx123@gmail.com --proxy
Expected output:
log
😊 Starting user -> xiesx123@gmail.com
✅ User successfully. uuid -> Q5tsyLZQtPMjOnSoK7chAdQVcdi2 (free)
4. Reset Password
- Default
bash
python cli.py auth -a resetpwd -e xiesx123@gmail.com
- With proxy
bash
python cli.py auth -a resetpwd -e xiesx123@gmail.com --proxy
Expected output:
log
😊 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 |
---|---|
![]() | ![]() |