配置说明

自定义 Novel Writer CLI 的行为和默认设置

配置文件位置

CLI 工具的配置文件存储位置

全局配置

# macOS / Linux

~/.novel/config.json

# Windows

%USERPROFILE%\.novel\config.json

项目配置

# 项目根目录

.novelrc

novel.config.json

项目配置会覆盖全局配置。配置文件支持 JSON 和 YAML 格式。

配置管理命令

使用 CLI 命令管理配置

# 查看当前配置

$ novel config list

# 设置配置项

$ novel config set <key> <value>

# 获取配置项

$ novel config get <key>

# 删除配置项

$ novel config delete <key>

# 重置为默认配置

$ novel config reset

# 编辑配置文件

$ novel config edit

配置选项详解

基础配置项

language

字符串

界面语言设置

默认值: "zh-CN"
可选: "zh-CN" | "zh-TW" | "en-US"

defaultProjectType

字符串

默认小说类型

默认值: "都市"
可选: "都市" | "玄幻" | "科幻" | "武侠" | "言情"

defaultStyle

字符串

默认写作风格

默认值: "轻松"
可选: "轻松" | "严肃" | "幽默" | "悬疑" | "细腻"

chapterWordCount

数字

章节默认字数

默认值: 3000
范围: 1000 - 10000

autoSave

布尔值

自动保存

默认值: true
说明: 每5分钟自动保存一次

完整配置示例

{
  "language": "zh-CN",
  "defaultProjectType": "都市",
  "defaultStyle": "轻松",
  "chapterWordCount": 3000,
  "autoSave": true,
  "api": {
    "endpoint": "https://api.novel-writer.cn",
    "token": "Bearer eyJ0eXAiOiJKV1QiLCJhb...",
    "timeout": 30000
  },
  "ai": {
    "enabled": true,
    "model": "gpt-4",
    "temperature": 0.8,
    "maxTokens": 2000,
    "contextWindow": 8000
  },
  "storage": {
    "path": "~/.novel"
  },
  "cache": {
    "enabled": true,
    "maxSize": "500MB"
  },
  "log": {
    "level": "info"
  }
}

命令别名

您可以为常用命令创建别名，提高工作效率

# 创建别名

$ novel config alias w "write --ai"

$ novel config alias up "upload --sync"

$ novel config alias qd "convert --format qidian"

# 使用别名

$ novel w chapter-1

$ novel up

$ novel qd

预设别名

n	novel
nw	novel write
nu	novel upload
nc	novel convert

环境变量

除了配置文件，您还可以通过环境变量覆盖配置

NOVEL_API_TOKEN	API Token
NOVEL_API_ENDPOINT	API 服务器地址
NOVEL_AI_MODEL	AI 模型选择
NOVEL_PROXY	代理服务器
NOVEL_LOG_LEVEL	日志级别

# 使用环境变量

$ export NOVEL_AI_MODEL=claude

$ export NOVEL_LOG_LEVEL=debug

$ novel write --ai

配置最佳实践

•将敏感信息（如 API Token）通过环境变量配置，避免提交到版本控制
•项目特定配置写入 `.novelrc` 文件，与团队共享
•定期清理缓存以释放磁盘空间
•开发环境设置 `log.level` 为 "debug" 便于调试
•使用命令别名简化常用操作流程