Appearance
CLI 参考
SceneFab 提供命令行入口，可直接启动 GUI，或在无 GUI 环境进入命令行模式。
基础命令
bash
# 启动 GUI（默认）
scenefab
# 查看版本
scenefab --version
# 查看帮助
scenefab --help命令行选项
| 选项 | 说明 | 示例 |
|---|---|---|
--version | 查看版本 | scenefab --version |
--help | 查看帮助 | scenefab --help |
--config <path> | 指定配置文件 | scenefab --config /path/to/config.yaml |
--output <dir> | 指定输出目录 | scenefab --output ./results |
--debug | 启用调试模式 | scenefab --debug |
--offline | 离线模式（仅 F5-TTS） | scenefab --offline |
命令行模式
当 PySide6 未安装或无法启动 GUI 时，SceneFab 自动进入命令行模式：
bash
scenefab可用功能：
text
SceneFab 命令行模式
------------------------------
可用功能:
1. AI 第一人称解说
2. 剪映草稿导出
3. 退出AI 第一人称解说
交互式生成视频解说：
- 输入视频文件路径
- 输入解说主题（可选）
- 选择 AI 生成或自定义解说词
- 自动生成配音和字幕
- 导出剪映草稿
剪映草稿导出
将视频导出为剪映可导入的草稿格式：
- 输入视频文件路径
- 输入项目名称
- 选择输出目录
- 自动生成剪映草稿文件
环境变量
通过环境变量配置 API Key 和运行参数：
LLM API Key
| 变量 | 说明 |
|---|---|
DEEPSEEK_API_KEY | DeepSeek API Key |
QWEN_API_KEY | 阿里云 Qwen API Key |
OPENAI_API_KEY | OpenAI API Key |
ANTHROPIC_API_KEY | Anthropic Claude API Key |
GEMINI_API_KEY | Google Gemini API Key |
运行参数
| 变量 | 说明 | 默认值 |
|---|---|---|
SCENEFAB_DEBUG | 调试模式 | false |
SCENEFAB_CACHE_DIR | 缓存目录 | ~/.cache/scenefab |
SCENEFAB_LOG_LEVEL | 日志级别 | INFO |
SCENEFAB_OFFLINE | 离线模式 | false |
示例配置
bash
# LLM API Key
export DEEPSEEK_API_KEY="sk-your-deepseek-key"
export QWEN_API_KEY="sk-your-qwen-key"
export OPENAI_API_KEY="sk-your-openai-key"
# 调试模式
export SCENEFAB_DEBUG=true
# 缓存目录
export SCENEFAB_CACHE_DIR="~/.cache/scenefab"
# 日志级别
export SCENEFAB_LOG_LEVEL="DEBUG"或使用 .env 文件：
bash
# .env
DEEPSEEK_API_KEY=sk-your-deepseek-key
QWEN_API_KEY=sk-your-qwen-key
SCENEFAB_DEBUG=false
SCENEFAB_LOG_LEVEL=INFOPython 模块调用
bash
# 通过 python -m 调用
python -m scenefab
# 指定配置文件
python -m scenefab --config ./config/llm.yaml
# 查看版本
python -m scenefab --version配置文件
配置文件位于项目根目录的 config/ 目录：
text
config/
├── app_config.yaml # 应用配置（缓存、视频参数、TTS、LLM）
└── llm.yaml # LLM 专用配置（API Key、模型）配置文件优先级
| 来源 | 优先级 | 示例 |
|---|---|---|
| 命令行参数 | 1（最高） | --config /path/to/config.yaml |
| 环境变量 | 2 | export DEEPSEEK_API_KEY=xxx |
.env 文件 | 3 | 项目根目录 .env |
config/*.yaml | 4（最低） | 项目根目录 config/llm.yaml |
返回码
| 返回码 | 说明 |
|---|---|
| 0 | 成功 |
| 1 | 通用错误 |
| 2 | 参数错误 |
| 3 | 配置文件错误 |
| 4 | API 调用失败 |
| 5 | 文件未找到 |
| 6 | FFmpeg 错误 |
常见问题
FFmpeg 未找到
bash
# 检查 FFmpeg
ffmpeg -version
# macOS 安装
brew install ffmpeg
# Ubuntu 安装
sudo apt install ffmpegGUI 无法启动
如果 PySide6 未安装，SceneFab 会自动切换到命令行模式：
bash
# 安装 PySide6
pip install PySide6
# 或使用命令行模式（无需 PySide6）
scenefabAPI Key 未配置
确保至少配置了一个 LLM 提供者的 API Key：
bash
# 检查配置
cat config/llm.yaml
# 检查环境变量
echo $DEEPSEEK_API_KEY详见 AI 配置。
配置文件加载失败
现象：ConfigError: Failed to load config/llm.yaml
解决：
bash
# 检查文件是否存在
ls -la config/llm.yaml
# 检查 YAML 语法
python -c "import yaml; yaml.safe_load(open('config/llm.yaml'))"调试模式
启用调试模式获取详细日志：
bash
# 命令行
scenefab --debug
# 环境变量
export SCENEFAB_DEBUG=true
scenefab日志文件位置：~/.cache/scenefab/logs/