Back to Details

configure

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Your Task

你的任务

Input: $ARGUMENTS
Route based on argument:
  • setup
    or no argument → Interactive first-time setup
  • edit
    → Edit specific settings
  • show
    → Display current configuration
  • validate
    → Check config for issues
  • reset
    → Delete config and start fresh
输入: $ARGUMENTS
根据参数进行路由：
  • setup
    或无参数 → 交互式首次设置
  • edit
    → 编辑特定设置
  • show
    → 显示当前配置
  • validate
    → 检查配置问题
  • reset
    → 删除配置并重新开始

Plugin Configuration Skill

插件配置Skill

You help users set up and manage their 
~/.bitwize-music/config.yaml
configuration.
你帮助用户设置和管理他们的
~/.bitwize-music/config.yaml
配置文件。

Config Location

配置文件位置

~/.bitwize-music/config.yaml
~/.bitwize-music/config.yaml

Commands

命令

/configure
or 
/configure setup

/configure
或 
/configure setup

Interactive first-time setup. Guide user through creating their config.
Steps:
  1. Check if 
    ~/.bitwize-music/config.yaml
    exists
  2. If exists, ask if they want to overwrite or edit instead
  3. If creating new:
    • Create 
      ~/.bitwize-music/
      directory if needed
    • Ask for each required setting interactively
    • Write the config file
    • Validate the result
Required settings to ask:
  1. artist.name
    - "What's your artist/project name?"
  2. paths.content_root
    - "Where should albums and projects be stored? (e.g., ~/music-projects)"
  3. paths.audio_root
    - "Where should mastered audio files go? (e.g., ~/music-projects/audio)"
  4. paths.documents_root
    - "Where should research documents/PDFs go? (e.g., ~/music-projects/documents)"
Optional settings: 5. 
artist.genres
- "What are your primary genres? (comma-separated, or skip)" 6. 
urls.soundcloud
- "SoundCloud profile URL? (or skip)"
Step 5: Overrides Directory (Optional)
Ask:
You can optionally provide a path to a directory containing override files. This is where you can customize workflows and skills without plugin update conflicts.
Override files you can create:
  • CLAUDE.md (custom workflow instructions)
  • pronunciation-guide.md (artist names, character names)
  • explicit-words.md (custom explicit word list)
Default: ~/music-projects/overrides
Enter path (or press Enter to use default):
If user provides path:
  • Add to config: 
    paths.overrides: "[user-path]"
If user presses Enter (accepts default):
  • Add to config: 
    paths.overrides: "~/music-projects/overrides"
  • Tell user: "Note: Directory doesn't need to exist yet. Create override files when you want to customize."
Step 6: Album Ideas File (Optional)
Ask:
You can optionally provide a path to a file for tracking album ideas. This is managed by the /bitwize-music:album-ideas skill for brainstorming and planning.
Default: ~/music-projects/IDEAS.md
Enter path (or press Enter to use default):
If user provides path:
  • Add to config: 
    paths.ideas_file: "[user-path]"
If user presses Enter (accepts default):
  • Add to config: 
    paths.ideas_file: "~/music-projects/IDEAS.md"
  • Tell user: "Note: File doesn't need to exist yet. The album-ideas skill creates it when first used."
Example interaction:
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!
交互式首次设置。引导用户创建他们的配置文件。
步骤：
  1. 检查
    ~/.bitwize-music/config.yaml
    是否存在
  2. 如果已存在，询问用户是否要覆盖或改为编辑
  3. 如果创建新配置：
    • 如有需要，创建
      ~/.bitwize-music/
      目录
    • 交互式询问每个必填设置项
    • 写入配置文件
    • 验证结果
需要询问的必填设置项：
  1. artist.name
    - "你的艺术家/项目名称是什么？"
  2. paths.content_root
    - "专辑和项目应该存储在哪里？（例如：~/music-projects）"
  3. paths.audio_root
    - "母带音频文件应该存放在哪里？（例如：~/music-projects/audio）"
  4. paths.documents_root
    - "研究文档/PDF应该存放在哪里？（例如：~/music-projects/documents）"
可选设置项： 5. 
artist.genres
- "你的主要音乐流派是什么？（逗号分隔，或跳过）" 6. 
urls.soundcloud
- "SoundCloud个人主页链接？（或跳过）"
步骤5：覆盖目录（可选）
询问：
你可以选择提供一个包含覆盖文件的目录路径。 在这里你可以自定义工作流和Skill，而不会与插件更新产生冲突。
你可以创建的覆盖文件：
  • CLAUDE.md（自定义工作流说明）
  • pronunciation-guide.md（艺术家名称、角色名称）
  • explicit-words.md（自定义敏感词汇列表）
默认路径：~/music-projects/overrides
输入路径（或按回车键使用默认值）：
如果用户提供路径：
  • 在配置中添加：
    paths.overrides: "[user-path]"
如果用户按回车键（接受默认值）：
  • 在配置中添加：
    paths.overrides: "~/music-projects/overrides"
  • 告知用户："注意：该目录无需提前创建。当你想要自定义时再创建覆盖文件即可。"
步骤6：专辑创意文件（可选）
询问：
你可以选择提供一个用于记录专辑创意的文件路径。 该文件由/bitwize-music:album-ideas Skill管理，用于头脑风暴和规划。
默认路径：~/music-projects/IDEAS.md
输入路径（或按回车键使用默认值）：
如果用户提供路径：
  • 在配置中添加：
    paths.ideas_file: "[user-path]"
如果用户按回车键（接受默认值）：
  • 在配置中添加：
    paths.ideas_file: "~/music-projects/IDEAS.md"
  • 告知用户："注意：该文件无需提前创建。首次使用album-ideas Skill时会自动创建。"
示例交互：
让我们来设置你的bitwize-music配置。

你的艺术家/项目名称是什么？
> Neon Circuits

专辑和项目应该存储在哪里？
（这里将存放你的专辑文件夹、歌词和研究资料）
> ~/music-projects

母带音频文件应该存放在哪里？
> ~/music-projects/audio

研究文档/PDF应该存放在哪里？
> ~/music-projects/documents

你的主要音乐流派是什么？（逗号分隔，或按回车键跳过）
> electronic, synthwave

SoundCloud个人主页链接？（或按回车键跳过）
> https://soundcloud.com/neon-circuits

覆盖目录路径？（按回车键使用默认值：~/music-projects/overrides）
> [Enter]

专辑创意文件路径？（按回车键使用默认值：~/music-projects/IDEAS.md）
> [Enter]

正在在~/.bitwize-music/config.yaml创建配置文件...

✓ 配置已保存！

你的设置：
  艺术家：Neon Circuits
  内容目录：~/music-projects
  音频目录：~/music-projects/audio
  文档目录：~/music-projects/documents
  流派：electronic, synthwave
  SoundCloud：https://soundcloud.com/neon-circuits
  覆盖目录：~/music-projects/overrides（创建后即可使用）
  创意文件：~/music-projects/IDEAS.md（首次使用时会创建）

你已准备好开始创建专辑了！

/configure edit

/configure edit

Edit specific settings without recreating the whole config.
Steps:
  1. Read existing config
  2. Show current values
  3. Ask what they want to change
  4. Update just that setting
  5. Validate and save
Example:
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?
无需重新创建整个配置，仅编辑特定设置项。
步骤：
  1. 读取现有配置
  2. 显示当前值
  3. 询问用户想要更改的内容
  4. 仅更新该设置项
  5. 验证并保存
示例：
当前配置：

  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

你想要更改什么？

/configure show

/configure show

Display the current configuration in a readable format.
Steps:
  1. Read 
    ~/.bitwize-music/config.yaml
  2. Display all settings in a formatted table
  3. Note any missing required settings
Example output:
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
以易读格式显示当前配置。
步骤：
  1. 读取
    ~/.bitwize-music/config.yaml
  2. 以格式化表格显示所有设置
  3. 标注任何缺失的必填设置项
示例输出：
bitwize-music配置
位置：~/.bitwize-music/config.yaml

┌─────────────────────┬────────────────────────────────────┐
│ 设置项              │ 值                                │
├─────────────────────┼────────────────────────────────────┤
│ 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                               │
└─────────────────────┴────────────────────────────────────┘

✓ 所有必填设置项均已存在

/configure validate

/configure validate

Check the config for issues.
Checks:
  1. Config file exists
  2. All required fields present
  3. Paths are valid (directories exist or can be created)
  4. No syntax errors in YAML
Example output:
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!
Or with issues:
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.
检查配置是否存在问题。
检查项：
  1. 配置文件是否存在
  2. 所有必填字段是否齐全
  3. 路径是否有效（目录已存在或可创建）
  4. YAML语法是否无错误
示例输出：
正在验证~/.bitwize-music/config.yaml...

✓ 配置文件存在
✓ artist.name: Neon Circuits
✓ 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（首次使用时会创建）
✓ generation.service: suno

所有检查通过！
或存在问题的情况：
正在验证~/.bitwize-music/config.yaml...

✓ 配置文件存在
✓ artist.name: Neon Circuits
✗ paths.content_root: 未设置（必填项）
✓ paths.audio_root: ~/music-projects/audio
✗ paths.documents_root: /invalid/path（目录不存在）

发现2个问题。运行/configure edit进行修复。

/configure reset

/configure reset

Delete config and optionally start fresh.
Steps:
  1. Confirm user really wants to reset
  2. Back up existing config to 
    config.yaml.bak
  3. Delete 
    ~/.bitwize-music/config.yaml
  4. Ask if they want to run setup now
Example:
⚠️  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)
If yes:
✓ 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)
删除配置文件并可选择重新开始设置。
步骤：
  1. 确认用户确实想要重置
  2. 将现有配置备份到
    config.yaml.bak
  3. 删除
    ~/.bitwize-music/config.yaml
  4. 询问用户是否要立即运行设置流程
示例：
⚠️  这将删除你在~/.bitwize-music/config.yaml的配置文件

当前配置将备份到config.yaml.bak

你确定要重置吗？（是/否）
如果用户选择是：
✓ 已备份到~/.bitwize-music/config.yaml.bak
✓ 已删除~/.bitwize-music/config.yaml

配置已重置。

你现在想要设置新的配置吗？（是/否）

Config Template

配置模板

When creating a new config, use this structure:
yaml
undefined
创建新配置时，使用以下结构：
yaml
undefined

bitwize-music Plugin Configuration

bitwize-music插件配置

Generated by /configure

由/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

---
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

---

Edge Cases

边缘情况

Config exists but is invalid YAML

配置文件存在但YAML无效

  • Back up the existing file: 
    config.yaml.bak
  • Offer to create fresh config
  • 将现有文件备份为
    config.yaml.bak
  • 提供创建全新配置的选项

Directory doesn't exist

目录不存在

  • Offer to create it: "Directory ~/music-projects doesn't exist. Create it?"
  • 询问是否创建："目录~/music-projects不存在。是否创建？"

User provides relative path

用户提供相对路径

  • Expand to absolute: 
    ./projects
    → 
    /Users/name/projects
  • Or use 
    ~
    prefix: 
    ~/projects
  • 扩展为绝对路径：
    ./projects
    → 
    /Users/name/projects
  • 或使用
    ~
    前缀：
    ~/projects

Remember

注意事项

  • Preserve exact casing - If user says "bitwize", write "bitwize" not "Bitwize"
  • Always expand 
    ~
    in paths for display
  • Create directories if they don't exist (with permission)
  • Back up existing config before overwriting
  • Validate after any changes
  • Be friendly and explain what each setting does
  • 保留确切大小写 - 如果用户输入"bitwize"，则写入"bitwize"而非"Bitwize"
  • 显示路径时始终展开
    ~
  • 若目录不存在则创建（需获得权限）
  • 覆盖配置前先备份现有配置
  • 任何更改后都要进行验证
  • 保持友好并解释每个设置项的作用