obsidian-cli-skill/plugins/obsidian-cli/config.yaml.example at main · cwaits6/obsidian-cli-skill · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
# Obsidian CLI Skill Configuration Template
# Copy this file to config.yaml and customize with your vault's specific values

# Life/domain contexts available in your vault
contexts:
  - work
  - personal

# Note types supported in your vault
note_types:
  note: General purpose note for anything that doesn't fit another type
  meeting: Meeting notes
  reference: Documents what something is or how something works. Also for learning, studying for certifications, or continuing education on a topic
  how-to: Step-by-step procedure for accomplishing a specific task
  troubleshooting: Problem and solution documentation
  snippet: Short, reusable commands, code patterns, config blocks, or API calls
  skill: AI skills that have been created or generated
  inbox: Quick capture with no structure

# Universal properties that apply to every note
universal_properties:
  type:
    description: Note classification
    required: true
    allowed_values: "Keys from note_types above"

  context:
    description: Life domain
    required: true
    allowed_values: "Values from contexts list above"

  topic:
    description: Broad categories - always a list, even for single values
    required: true
    type: list
    examples: [kubernetes, aws, terraform, networking, finance]

  project:
    description: Specific initiative
    required: false
    type: string

  tags:
    description: Freeform catch-all for miscellaneous metadata
    required: false
    type: list

# Conditional properties that apply only to certain note types
conditional_properties:
  troubleshooting:
    resolved:
      description: Whether the issue has been resolved
      type: boolean
      default: false

# File and folder naming conventions
naming_conventions:
  file_format: lowercase-kebab-case
  file_examples: my-meeting-notes.md, eks-irsa-setup.md
  folder_format: Capitalized-Kebab-Case
  folder_examples: My-Notes, Projects, Reference

# Batch operation settings
batch_settings:
  # Maximum number of notes to process per batch during migrations
  # Keeps context manageable for large vaults. Notes beyond this limit
  # are split into multiple batches, each proposed and approved separately.
  max_batch_size: 15

  # How approval works for batch operations (migrations, bulk property changes)
  #   batch  - Approve the entire batch at once, then all operations execute without further prompts (default)
  #   single - Approve each note individually before its properties are set and it is moved
  approval_mode: batch

# Vault path (optional - helps for relative path operations)
vault_path: /path/to/your/vault