Quick Start
# source 共享函数库
source scripts/functions.sh
# 在当前环境配置 SwanLab
swanlab_setup
# 为指定容器配置
swanlab_setup_for_container my_container
# 检查连接状态
swanlab_check
Configuration Retrieval Priority
Environment variables > Configuration file > Interactive input
| Method | Variable/Path | Description |
|---|---|---|
| Environment variables | SWANLAB_HOST, SWANLAB_API_KEY |
Recommended method |
| Configuration file | ~/.verl/swanlab.conf |
Automatically saved after first interaction |
| Interactive input | Terminal prompt | Only triggered in an interactive terminal |
API
Script scripts/functions.sh provides sourceable functions:
| Function | Purpose |
|---|---|
swanlab_clear_proxy |
Clear proxy settings (required for SwanLab connection) |
swanlab_load_config |
Load configuration (environment variables > file) |
swanlab_save_config HOST KEY |
Save configuration to ~/.verl/swanlab.conf |
swanlab_prompt_config |
Interactively retrieve configuration |
swanlab_init |
Initialize configuration by priority |
swanlab_login |
Execute pip install + swanlab login in the current environment |
swanlab_setup |
Complete process: clear_proxy + init + login |
swanlab_setup_for_container NAME |
Execute swanlab_setup inside the specified container |
swanlab_check |
Check login status and network connectivity |
How Other Skills Call It
# 1. 发现 skill 路径（推荐通过环境变量）
SWANLAB_SETUP_PATH="${SWANLAB_SETUP_PATH:-$(dirname "$(find ~/.claude/skills/swanlab-setup -name functions.sh 2>/dev/null || echo "")")}"
# 2. source 函数库
source "$SWANLAB_SETUP_PATH/scripts/functions.sh"
# 3. 调用
swanlab_setup
Script Structure
swanlab-setup/
├── SKILL.md # 本文档
└── scripts/
├── functions.sh # 共享函数库（被其他 skill source）
└── swanlab_check.sh # 独立检查脚本