关于 configure
用于设置和管理 bitwize-music 插件配置的技能,适合首次配置或维护现有设置的人。它支持交互式设置、编辑、查看、验证和重置,并在重置或覆盖前备份配置。
主要功能
- 01交互式创建初始配置
- 02查看并编辑现有设置
- 03验证必填项、路径和 YAML
- 04重置配置前备份文件
适用场景
- 01首次配置音乐项目路径和艺名
- 02修改或检查现有配置
- 03配置无效时备份并重新设置
安装
复制下面的命令,在终端中运行。
npx skills add https:/ / github.com/ bitwize-music-studio/ claude-ai-music-skills --skill configure安装后在 Claude Code 中输入/configure确认已加载。
附带文件SETTINGS_REFERENCE.md
详细介绍
你的任务
输入:$ARGUMENTS
根据参数路由:
setup或不提供参数 → 交互式首次设置edit→ 编辑特定设置show→ 显示当前配置validate→ 检查配置问题reset→ 删除配置并重新开始
插件配置技能
你可以帮助用户设置和管理其 ~/.bitwize-music/config.yaml 配置。
配置位置
~/.bitwize-music/config.yaml
命令
/configure 或 /configure setup
交互式首次设置。引导用户创建配置。
步骤:
- 检查
~/.bitwize-music/config.yaml是否存在 - 如果存在,询问用户是要覆盖配置还是改为编辑
- 如果要创建新配置:
- 如果需要,创建
~/.bitwize-music/目录 - 逐项交互式询问每个必需设置
- 写入配置文件
- 验证结果
- 如果需要,创建
要询问的必需设置:
artist.name- “你的艺人/项目名称是什么?”paths.content_root- “专辑和项目应存储在哪里?(例如,~/music-projects)”paths.audio_root- “母带音频文件应放在哪里?(例如,~/music-projects/audio)”paths.documents_root- “研究文档/PDF 应放在哪里?(例如,~/music-projects/documents)”
可选设置:
5. artist.genres - “你的主要流派是什么?(用逗号分隔,或跳过)”
6. urls.soundcloud - “SoundCloud 个人资料 URL?(或跳过)”
第 5 步:覆盖目录(可选)
询问:
你可以选择提供一个包含覆盖文件的目录路径。 在此处自定义工作流和技能,可避免与插件更新发生冲突。
你可以创建的覆盖文件:
- CLAUDE.md(自定义工作流说明)
- pronunciation-guide.md(艺人名称、角色名称)
- explicit-words.md(自定义敏感词列表)
默认值:~/music-projects/overrides
输入路径(或按 Enter 使用默认值):
如果用户提供路径:
- 在配置中添加:
paths.overrides: "[user-path]"
如果用户按 Enter(接受默认值):
- 在配置中添加:
paths.overrides: "~/music-projects/overrides" - 告知用户:“注意:目录目前不需要存在。需要自定义时再创建覆盖文件。”
第 6 步:专辑创意文件(可选)
询问:
你可以选择提供一个用于记录专辑创意的文件路径。 此文件由 /bitwize-music:album-ideas 技能管理,用于头脑风暴和规划。
默认值:~/music-projects/IDEAS.md
输入路径(或按 Enter 使用默认值):
如果用户提供路径:
- 在配置中添加:
paths.ideas_file: "[user-path]"
如果用户按 Enter(接受默认值):
- 在配置中添加:
paths.ideas_file: "~/music-projects/IDEAS.md" - 告知用户:“注意:文件目前不需要存在。首次使用时,album-ideas 技能会创建该文件。”
交互示例:
Let's set up your bitwize-music configuration.
What's your artist/project name?
> Neon Circuits
Where should albums and projects be stored?
(This is where your album folders, lyrics, and research will live)
> ~/music-projects
Where should mastered audio files go?
> ~/music-projects/audio
Where should research documents/PDFs go?
> ~/music-projects/documents
What are your primary genres? (comma-separated, or press Enter to skip)
> electronic, synthwave
SoundCloud profile URL? (or press Enter to skip)
> https://soundcloud.com/neon-circuits
Overrides directory path? (press Enter for default: ~/music-projects/overrides)
> [Enter]
Album ideas file path? (press Enter for default: ~/music-projects/IDEAS.md)
> [Enter]
Creating config at ~/.bitwize-music/config.yaml...
✓ Configuration saved!
Your settings:
Artist: Neon Circuits
Content: ~/music-projects
Audio: ~/music-projects/audio
Documents: ~/music-projects/documents
Genres: electronic, synthwave
SoundCloud: https://soundcloud.com/neon-circuits
Overrides: ~/music-projects/overrides (will be used if created)
Ideas File: ~/music-projects/IDEAS.md (will be created when first used)
You're ready to start creating albums!
/configure edit
编辑特定设置,无需重新创建整个配置。
步骤:
- 读取现有配置
- 显示当前值
- 询问用户想要更改哪些内容
- 仅更新该设置
- 验证并保存
示例:
Current configuration:
artist.name: Neon Circuits
paths.content_root: ~/music-projects
paths.audio_root: ~/music-projects/audio
paths.documents_root: ~/music-projects/documents
artist.genres: [electronic, synthwave]
urls.soundcloud: https://soundcloud.com/neon-circuits
What would you like to change?
/configure show
以易读的格式显示当前配置。
步骤:
- 读取
~/.bitwize-music/config.yaml - 在格式化表格中显示所有设置
- 指出任何缺失的必需设置
输出示例:
bitwize-music Configuration
Location: ~/.bitwize-music/config.yaml
┌─────────────────────┬────────────────────────────────────┐
│ Setting │ Value │
├─────────────────────┼────────────────────────────────────┤
│ artist.name │ Neon Circuits │
│ artist.genres │ electronic, synthwave │
│ paths.content_root │ ~/music-projects │
│ paths.audio_root │ ~/music-projects/audio │
│ paths.documents_root│ ~/music-projects/documents │
│ paths.overrides │ ~/music-projects/overrides │
│ paths.ideas_file │ ~/music-projects/IDEAS.md │
│ urls.soundcloud │ https://soundcloud.com/neon-circuits│
│ generation.service │ suno │
└─────────────────────┴────────────────────────────────────┘
✓ All required settings present
/configure validate
检查配置是否存在问题。
检查项:
- 配置文件是否存在
- 是否包含所有必需字段
- 路径是否有效(目录已存在或可以创建)
- YAML 是否存在语法错误
输出示例:
Validating ~/.bitwize-music/config.yaml...
✓ Config file exists
✓ artist.name: Neon Circuits
✓ paths.content_root: ~/music-projects (exists)
✓ paths.audio_root: ~/music-projects/audio (exists)
✓ paths.documents_root: ~/music-projects/documents (will be created)
✓ paths.overrides: ~/music-projects/overrides (will be used if created)
✓ paths.ideas_file: ~/music-projects/IDEAS.md (will be created when first used)
✓ generation.service: suno
All checks passed!
存在问题时:
Validating ~/.bitwize-music/config.yaml...
✓ Config file exists
✓ artist.name: Neon Circuits
✗ paths.content_root: not set (required)
✓ paths.audio_root: ~/music-projects/audio
✗ paths.documents_root: /invalid/path (directory doesn't exist)
2 issues found. Run /configure edit to fix.
/configure reset
删除配置,并可选择重新开始。
步骤:
- 确认用户确实要重置
- 将现有配置备份为
config.yaml.bak - 删除
~/.bitwize-music/config.yaml - 询问用户是否要立即运行设置
示例:
⚠️ This will delete your configuration at ~/.bitwize-music/config.yaml
Current config will be backed up to config.yaml.bak
Are you sure you want to reset? (yes/no)
如果是:
✓ Backed up to ~/.bitwize-music/config.yaml.bak
✓ Deleted ~/.bitwize-music/config.yaml
Config has been reset.
Would you like to set up a new config now? (yes/no)
配置模板
创建新配置时,使用以下结构:
# bitwize-music Plugin Configuration
# Generated by /configure
artist:
name: "{artist_name}"
genres:
- "{genre1}"
- "{genre2}"
paths:
content_root: "{content_root}"
audio_root: "{audio_root}"
documents_root: "{documents_root}"
overrides: "{overrides}"
ideas_file: "{ideas_file}"
urls:
soundcloud: "{soundcloud_url}"
generation:
service: suno
边缘情况
配置文件存在,但 YAML 无效
- 备份现有文件:
config.yaml.bak - 提议创建新的配置文件
目录不存在
- 提议创建该目录:"目录 ~/music-projects 不存在。要创建吗?"
用户提供相对路径
- 转换为绝对路径:
./projects→/Users/name/projects - 或使用
~前缀:~/projects
请记住
- 保留原有大小写——如果用户说“bitwize”,就写“bitwize”,不要写成“Bitwize”
- 显示路径时,始终展开
~ - 如果目录不存在,则创建目录(需获得许可)
- 覆盖现有配置文件前,先备份
- 进行任何更改后,都要验证
- 友好地解释每项设置的作用