Skip to content
Kward Search API index

Module: Kward::ConfigFiles

Defined in:
lib/kward/config_files.rb

Overview

Resolves Kward configuration, cache, memory, prompt, skill, and plugin paths, and reads/writes the JSON config file used by the CLI and RPC server.

This module is the configuration boundary, not a runtime settings cache. Most methods read the filesystem each time so CLI commands and RPC reloads can observe edits made outside the process. Callers that need caching should own invalidation explicitly, as Client#reload_config does for provider state.

Keep path decisions here. Higher-level code should ask ConfigFiles for config, prompt, skill, plugin, cache, memory, and session locations instead of reconstructing ~/.kward paths independently.

Defined Under Namespace

Classes: ConfigError, PromptTemplate, Skill

Constant Summary collapse

MAX_SKILL_FILE_BYTES = 
100_000
MAX_PROMPT_FILE_BYTES = 
32 * 1024
DEFAULT_OVERLAY_SETTINGS = 
{ "alignment" => "center", "width" => "maximum" }.freeze
PROJECT_BROWSER_ICON_THEMES = 
%w[off nerd-font].freeze
DEFAULT_PERSONAS = 
{
  "characters" => [
    {
      "key" => "kward",
      "label" => "Kward",
      "instruction" => "Your name is Kward, the grim Andruid - robotic keeper of the Forest of Code, protecting the nature of good engineering principles. Speak like an old druid, be suspicious of everyone, but with good intent."
    }
  ],
  "default" => "kward"
}.freeze
OVERLAY_ALIGNMENTS = 
%w[left center right].freeze
OVERLAY_WIDTHS = 
%w[capped maximum].freeze

Class Method Summary collapse

Class Method Details

.active_persona_label(workspace_root:, model: nil, config: read_config) ⇒ Object

Returns the label of the persona selected by default/workspace/model rules.



599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
 
# File 'lib/kward/config_files.rb', line 599

def active_persona_label(workspace_root:, model: nil, config: read_config)
  personas = config["personas"]
  return nil unless personas.is_a?(Hash)

  labels = crew_character_labels(personas)
  active_label = persona_label_for_key(personas["default"], labels) unless personas["default"].nil?

  workspaces = personas["workspaces"]
  if workspaces.is_a?(Hash)
    root = canonical_workspace_root(workspace_root)
    workspaces.each do |path, key|
      next unless canonical_workspace_root(path) == root

      active_label = persona_label_for_key(key, labels)
      break
    end
  end

  models = personas["models"]
  if models.is_a?(Hash) && !model.to_s.empty? && models.key?(model.to_s)
    active_label = persona_label_for_key(models[model.to_s], labels)
  end

  active_label
end

.add_persona_entry(entries, layer, value, name: nil) ⇒ Object 



709
710
711
712
713
714
 
# File 'lib/kward/config_files.rb', line 709

def add_persona_entry(entries, layer, value, name: nil)
  text = presence(value)
  return unless text

  entries << { layer: layer.to_s, name: name.to_s, prompt: text }
end

.agents_prompt ⇒ String?

Reads global principle instructions from the config directory.

PRINCIPLES.md is preferred. AGENTS.md remains a backwards-compatible alias for existing installations.

Returns:

  • (String, nil) —

    prompt text, or nil when absent/too large



561
562
563
564
565
566
 
# File 'lib/kward/config_files.rb', line 561

def agents_prompt
  path = config_principles_path
  return read_prompt_file(path, "Kward principles file") if File.exist?(path)

  read_prompt_file(config_agents_path, "Kward AGENTS.md alias")
end

.cache_dir ⇒ String

Returns directory containing reusable local caches.

Returns:

  • (String) —

    directory containing reusable local caches



95
96
97
 
# File 'lib/kward/config_files.rb', line 95

def cache_dir
  File.join(config_dir, "cache")
end

.canonical_workspace_root(path) ⇒ Object 



704
705
706
707
 
# File 'lib/kward/config_files.rb', line 704

def canonical_workspace_root(path)
  expanded = File.expand_path(path.to_s.empty? ? Dir.pwd : path.to_s)
  File.directory?(expanded) ? File.realpath(expanded) : expanded
end

.character_entries(raw) ⇒ Object 



756
757
758
759
760
761
762
763
764
765
 
# File 'lib/kward/config_files.rb', line 756

def character_entries(raw)
  case raw
  when Hash
    raw.map { |key, definition| [key, definition] }
  when Array
    raw.filter_map { |entry| character_entry(entry) }
  else
    []
  end
end

.character_entry(entry) ⇒ Object 



767
768
769
770
771
772
773
774
775
776
 
# File 'lib/kward/config_files.rb', line 767

def character_entry(entry)
  return nil unless entry.is_a?(Hash)

  if entry.length == 1 && entry.keys.first.is_a?(String)
    [entry.keys.first, entry.values.first]
  else
    key = entry["key"] || entry[:key] || entry["id"] || entry[:id] || entry["name"] || entry[:name]
    key.to_s.empty? ? nil : [key, entry]
  end
end

.code_search_cache_dir ⇒ Object 



175
176
177
 
# File 'lib/kward/config_files.rb', line 175

def code_search_cache_dir
  File.join(cache_dir, "code_search")
end

.composer_busy_help?(config = read_config) ⇒ Boolean

Returns whether the composer should show busy-state keyboard help.

Returns:

  • (Boolean) 


436
437
438
439
 
# File 'lib/kward/config_files.rb', line 436

def composer_busy_help?(config = read_config)
  composer = config["composer"].is_a?(Hash) ? config["composer"] : {}
  composer["busy_help"] != false
end

.composer_tab_keybindings(config = read_config) ⇒ Object

Returns the configured tab keybinding family, or auto when unset/invalid.



442
443
444
445
446
 
# File 'lib/kward/config_files.rb', line 442

def composer_tab_keybindings(config = read_config)
  composer = config["composer"].is_a?(Hash) ? config["composer"] : {}
  value = composer["tab_keybindings"].to_s.downcase
  %w[auto ctrl alt].include?(value) ? value : "auto"
end

.config_agents_path ⇒ Object 



572
573
574
 
# File 'lib/kward/config_files.rb', line 572

def config_agents_path
  File.join(config_dir, "AGENTS.md")
end

.config_dir ⇒ String

Directory that contains Kward's user config and adjacent prompt/skill data. Defaults to ~/.kward, or the directory of KWARD_CONFIG_PATH.

Returns:

  • (String) —

    expanded config directory path



82
83
84
85
86
87
 
# File 'lib/kward/config_files.rb', line 82

def config_dir
  config_path = ENV["KWARD_CONFIG_PATH"]
  return File.expand_path(File.dirname(config_path)) if config_path && !config_path.empty?

  File.expand_path("~/.kward")
end

.config_path ⇒ String

Returns expanded JSON config file path.

Returns:

  • (String) —

    expanded JSON config file path



90
91
92
 
# File 'lib/kward/config_files.rb', line 90

def config_path
  File.expand_path(ENV["KWARD_CONFIG_PATH"] || File.join(config_dir, "config.json"))
end

.config_principles_path ⇒ Object 



568
569
570
 
# File 'lib/kward/config_files.rb', line 568

def config_principles_path
  File.join(config_dir, "PRINCIPLES.md")
end

.config_value(config, *keys) ⇒ Object

Returns the first present non-empty string value among several config keys.



405
406
407
408
409
410
411
 
# File 'lib/kward/config_files.rb', line 405

def config_value(config, *keys)
  keys.each do |key|
    text = presence(config[key])
    return text if text
  end
  nil
end

.crew_character_labels(personas) ⇒ Object 



722
723
724
725
726
 
# File 'lib/kward/config_files.rb', line 722

def crew_character_labels(personas)
  named_character_values(personas) do |_key, definition|
    extract_character_label(definition)
  end
end

.crew_characters(personas) ⇒ Object 



716
717
718
719
720
 
# File 'lib/kward/config_files.rb', line 716

def crew_characters(personas)
  named_character_values(personas) do |_key, definition|
    extract_character_instruction(definition)
  end
end

.default_config ⇒ Hash

Returns a fresh default config suitable for first-run persistence.

Returns:

  • (Hash) —

    deep-mutable config defaults



115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
 
# File 'lib/kward/config_files.rb', line 115

def default_config
  {
    "personas" => JSON.parse(JSON.generate(DEFAULT_PERSONAS)),
    "memory" => {
      "enabled" => false,
      "auto_summary" => false
    },
    "composer" => {
      "busy_help" => true,
      "tab_keybindings" => "auto"
    },
    "editor" => {
      "mode" => "modern",
      "auto_indent" => true,
      "auto_close_pairs" => true,
      "soft_wrap" => true,
      "bar_cursor" => true,
      "line_numbers" => "absolute",
      "diff_view" => "auto"
    },
    "overlay" => DEFAULT_OVERLAY_SETTINGS.dup,
    "project_browser" => {
      "icons" => "off"
    },
    "web_search" => {
      "enabled" => true,
      "provider" => "auto",
      "allow_model_providers" => false
    },
    "updates" => {
      "check" => true
    },
    "sessions" => {
      "auto_resume" => false
    },
    "skills" => {
      "trust_project" => false
    },
    "enforce_workspace_agents_file" => false,
    "mcpServers" => {},
    "tools" => {
      "workspace_guardrails" => true
    },
    "permissions" => {
      "enabled" => false,
      "mode" => "ask"
    }
  }
end

.delete_config_key(key, path = config_path) ⇒ Object

Removes a top-level config key when it exists.



396
397
398
399
400
401
402
 
# File 'lib/kward/config_files.rb', line 396

def delete_config_key(key, path = config_path)
  config = read_config(path)
  existed = config.key?(key.to_s)
  config.delete(key.to_s)
  write_config(config, path) if existed
  existed
end

.diff_view(config = read_config) ⇒ Object

Returns the integrated diff viewer display mode.



485
486
487
488
 
# File 'lib/kward/config_files.rb', line 485

def diff_view(config = read_config)
  editor = config["editor"].is_a?(Hash) ? config["editor"] : {}
  DiffViewMode.normalize(editor["diff_view"])
end

.editor_auto_close_pairs?(config = read_config) ⇒ Boolean

Returns whether the built-in TUI editor should auto-close typed pairs.

Returns:

  • (Boolean) 


461
462
463
464
 
# File 'lib/kward/config_files.rb', line 461

def editor_auto_close_pairs?(config = read_config)
  editor = config["editor"].is_a?(Hash) ? config["editor"] : {}
  editor["auto_close_pairs"] != false
end

.editor_auto_indent?(config = read_config) ⇒ Boolean

Returns whether the built-in TUI editor should auto-indent new lines.

Returns:

  • (Boolean) 


455
456
457
458
 
# File 'lib/kward/config_files.rb', line 455

def editor_auto_indent?(config = read_config)
  editor = config["editor"].is_a?(Hash) ? config["editor"] : {}
  editor["auto_indent"] != false
end

.editor_bar_cursor?(config = read_config) ⇒ Boolean

Returns whether editable built-in TUI editor buffers should use a bar cursor.

Returns:

  • (Boolean) 


473
474
475
476
 
# File 'lib/kward/config_files.rb', line 473

def editor_bar_cursor?(config = read_config)
  editor = config["editor"].is_a?(Hash) ? config["editor"] : {}
  editor["bar_cursor"] != false
end

.editor_line_numbers(config = read_config) ⇒ Object

Returns the built-in TUI editor line-number display mode.



479
480
481
482
 
# File 'lib/kward/config_files.rb', line 479

def editor_line_numbers(config = read_config)
  editor = config["editor"].is_a?(Hash) ? config["editor"] : {}
  EditorMode.normalize_line_numbers(editor["line_numbers"])
end

.editor_mode(config = read_config) ⇒ Object

Returns the built-in TUI editor keymap mode.



449
450
451
452
 
# File 'lib/kward/config_files.rb', line 449

def editor_mode(config = read_config)
  editor = config["editor"].is_a?(Hash) ? config["editor"] : {}
  EditorMode.normalize(editor["mode"])
end

.editor_soft_wrap?(config = read_config) ⇒ Boolean

Returns whether the built-in TUI editor should soft-wrap long lines.

Returns:

  • (Boolean) 


467
468
469
470
 
# File 'lib/kward/config_files.rb', line 467

def editor_soft_wrap?(config = read_config)
  editor = config["editor"].is_a?(Hash) ? config["editor"] : {}
  editor["soft_wrap"] != false
end

.ekwsh_config_path ⇒ String

Returns embedded-shell YAML config path.

Returns:

  • (String) —

    embedded-shell YAML config path



100
101
102
 
# File 'lib/kward/config_files.rb', line 100

def ekwsh_config_path
  File.join(config_dir, "ekwsh.yml")
end

.enforce_workspace_agents_file?(config = read_config) ⇒ Boolean

Returns whether workspace AGENTS.md contents should be injected directly instead of a compact read-when-relevant instruction.

Returns:

  • (Boolean) 


515
516
517
 
# File 'lib/kward/config_files.rb', line 515

def enforce_workspace_agents_file?(config = read_config)
  config["enforce_workspace_agents_file"] == true
end

.ensure_default_config!(path = config_path) ⇒ Object

Performs ensure default config for configuration file and path handling.



166
167
168
169
170
171
172
173
 
# File 'lib/kward/config_files.rb', line 166

def ensure_default_config!(path = config_path)
  path = File.expand_path(path)
  return false if skip_config? && path == config_path
  return false if File.exist?(path)

  write_config(default_config, path)
  true
end

.extract_character_instruction(definition) ⇒ Object 



784
785
786
787
788
789
790
791
792
793
 
# File 'lib/kward/config_files.rb', line 784

def extract_character_instruction(definition)
  return nil if definition.nil?

  if definition.is_a?(Hash)
    value = definition["instruction"] || definition[:instruction]
    return presence(value)
  end

  presence(definition)
end

.extract_character_label(definition) ⇒ Object 



778
779
780
781
782
 
# File 'lib/kward/config_files.rb', line 778

def extract_character_label(definition)
  return nil unless definition.is_a?(Hash)

  presence(definition["label"] || definition[:label])
end

.inside_directory?(path, base) ⇒ Boolean

Returns:

  • (Boolean) 


873
874
875
 
# File 'lib/kward/config_files.rb', line 873

def inside_directory?(path, base)
  PathGuard.inside?(path, base)
end

.lifecycle_hooks_config(workspace_root = Dir.pwd) ⇒ Object 



245
246
247
248
249
250
251
 
# File 'lib/kward/config_files.rb', line 245

def lifecycle_hooks_config(workspace_root = Dir.pwd)
  config = read_config
  workspace_config = read_trusted_workspace_hooks_config(workspace_root)
  return config if workspace_config.empty?

  merge_hooks_config(config, workspace_config)
end

.mcp_servers(config = read_config) ⇒ Object

Returns configured MCP stdio servers, or an empty config when absent.



526
527
528
529
 
# File 'lib/kward/config_files.rb', line 526

def mcp_servers(config = read_config)
  value = config["mcpServers"] || config.dig("mcp", "servers")
  value.is_a?(Hash) ? value : {}
end

.memory_core_path ⇒ Object 



203
204
205
 
# File 'lib/kward/config_files.rb', line 203

def memory_core_path
  File.join(memory_dir, "core.json")
end

.memory_dir ⇒ String

Returns directory containing structured memory files.

Returns:

  • (String) —

    directory containing structured memory files



199
200
201
 
# File 'lib/kward/config_files.rb', line 199

def memory_dir
  File.join(config_dir, "memory")
end

.memory_events_path ⇒ Object 



211
212
213
 
# File 'lib/kward/config_files.rb', line 211

def memory_events_path
  File.join(memory_dir, "events.jsonl")
end

.memory_soft_path ⇒ Object 



207
208
209
 
# File 'lib/kward/config_files.rb', line 207

def memory_soft_path
  File.join(memory_dir, "soft.jsonl")
end

.merge_hook_maps(left, right) ⇒ Object 



301
302
303
304
305
306
307
308
309
 
# File 'lib/kward/config_files.rb', line 301

def merge_hook_maps(left, right)
  left = left.is_a?(Hash) ? left : {}
  right = right.is_a?(Hash) ? right : {}
  merged = JSON.parse(JSON.generate(left))
  right.each do |event, entries|
    merged[event.to_s] = Array(merged[event.to_s]) + Array(entries)
  end
  merged
end

.merge_hooks_config(config, workspace_config) ⇒ Object 



295
296
297
298
299
 
# File 'lib/kward/config_files.rb', line 295

def merge_hooks_config(config, workspace_config)
  merged = JSON.parse(JSON.generate(config || {}))
  merged["hooks"] = merge_hook_maps(merged["hooks"], workspace_config["hooks"] || workspace_config[:hooks])
  merged
end

.named_character_values(personas) ⇒ Object 



747
748
749
750
751
752
753
754
 
# File 'lib/kward/config_files.rb', line 747

def named_character_values(personas)
  character_entries(personas["characters"] || personas["crew"]).each_with_object({}) do |(key, definition), mapping|
    value = yield(key, definition)
    next if value.to_s.empty?

    mapping[key.to_s] = value
  end
end

.normalize_ekwsh_aliases(values) ⇒ Object 



361
362
363
364
365
366
367
368
369
370
371
372
 
# File 'lib/kward/config_files.rb', line 361

def normalize_ekwsh_aliases(values)
  return {} unless values.is_a?(Hash)

  values.each_with_object({}) do |(name, command), result|
    name = name.to_s
    command = command.to_s.strip
    next unless Ekwsh.valid_alias_name?(name)
    next if command.empty?

    result[name] = command
  end
end

.normalize_ekwsh_config(data) ⇒ Object 



321
322
323
324
325
326
327
328
329
330
331
332
 
# File 'lib/kward/config_files.rb', line 321

def normalize_ekwsh_config(data)
  data = data.transform_keys(&:to_s) if data.is_a?(Hash)
  settings = data.is_a?(Hash) ? data : {}
  {
    shell: normalize_ekwsh_shell(settings["shell"]),
    timeout_seconds: normalize_positive_integer(settings["timeout_seconds"], Ekwsh::DEFAULT_TIMEOUT_SECONDS),
    max_output_bytes: normalize_positive_integer(settings["max_output_bytes"], Ekwsh::DEFAULT_MAX_OUTPUT_BYTES),
    history_limit: normalize_positive_integer(settings["history_limit"], Ekwsh::DEFAULT_HISTORY_LIMIT),
    env: normalize_ekwsh_env(settings["env"]),
    aliases: normalize_ekwsh_aliases(settings["aliases"])
  }
end

.normalize_ekwsh_env(values) ⇒ Object 



349
350
351
352
353
354
355
356
357
358
359
 
# File 'lib/kward/config_files.rb', line 349

def normalize_ekwsh_env(values)
  return {} unless values.is_a?(Hash)

  values.each_with_object({}) do |(key, value), result|
    key = key.to_s
    next unless key.match?(/\A[A-Za-z_][A-Za-z0-9_]*\z/)
    next if value.nil?

    result[key] = value.to_s
  end
end

.normalize_ekwsh_shell(value) ⇒ Object 



334
335
336
337
338
339
340
 
# File 'lib/kward/config_files.rb', line 334

def normalize_ekwsh_shell(value)
  shell = value.to_s.strip
  return Ekwsh::DEFAULT_SHELL if shell.empty?
  return shell if shell.start_with?("/") && File.executable?(shell)

  Ekwsh::DEFAULT_SHELL
end

.normalize_positive_integer(value, default) ⇒ Object 



342
343
344
345
346
347
 
# File 'lib/kward/config_files.rb', line 342

def normalize_positive_integer(value, default)
  integer = Integer(value)
  integer.positive? ? integer : default
rescue ArgumentError, TypeError
  default
end

.openrouter_models_cache_path ⇒ Object 



179
180
181
 
# File 'lib/kward/config_files.rb', line 179

def openrouter_models_cache_path
  File.join(cache_dir, "openrouter_models.json")
end

.overlay_settings(config = read_config) ⇒ Hash

Returns validated overlay settings with defaults for missing or invalid values.

Parameters:

  • config (Hash) (defaults to: read_config) —

    parsed config object

Returns:

  • (Hash) —

    overlay settings with alignment and width



418
419
420
421
422
423
424
425
426
 
# File 'lib/kward/config_files.rb', line 418

def overlay_settings(config = read_config)
  overlay = config["overlay"].is_a?(Hash) ? config["overlay"] : {}
  settings = DEFAULT_OVERLAY_SETTINGS.dup
  alignment = overlay["alignment"].to_s
  width = overlay["width"].to_s
  settings["alignment"] = alignment if OVERLAY_ALIGNMENTS.include?(alignment)
  settings["width"] = width if OVERLAY_WIDTHS.include?(width)
  settings
end

.permission_policy(config = read_config) ⇒ Object

Builds the opt-in model-tool permission policy from persisted configuration.



497
498
499
 
# File 'lib/kward/config_files.rb', line 497

def permission_policy(config = read_config)
  Permissions::Policy.from_config(config)
end

.persona_entries(workspace_root:, model: nil, reasoning_effort: nil, now: Time.now, config: read_config, include_reasoning: true) ⇒ Object 



625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
 
# File 'lib/kward/config_files.rb', line 625

def persona_entries(workspace_root:, model: nil, reasoning_effort: nil, now: Time.now, config: read_config, include_reasoning: true)
  personas = config["personas"]
  return [] unless personas.is_a?(Hash)

  characters = crew_characters(personas)
  entries = []
  active_persona = { layer: "default", value: personas["default"], name: nil }

  workspaces = personas["workspaces"]
  if workspaces.is_a?(Hash)
    root = canonical_workspace_root(workspace_root)
    workspaces.each do |path, key|
      if canonical_workspace_root(path) == root
        active_persona = { layer: "workspace", value: key, name: path }
        break
      end
    end
  end

  models = personas["models"]
  if models.is_a?(Hash) && !model.to_s.empty? && models.key?(model.to_s)
    active_persona = { layer: "model", value: models[model.to_s], name: model.to_s }
  end

  add_persona_entry(
    entries,
    active_persona.fetch(:layer),
    resolved_persona_text(active_persona.fetch(:value), characters: characters),
    name: active_persona[:name]
  )

  modifiers = personas["persona_modifiers"]
  if modifiers.is_a?(Hash)
    if include_reasoning
      reasoning = modifiers["reasoning"]
      add_persona_entry(entries, "reasoning", reasoning[reasoning_effort.to_s]) if reasoning.is_a?(Hash) && !reasoning_effort.to_s.empty?
    end

    time_of_day = modifiers["time_of_day"]
    bucket = time_of_day_bucket(now)
    add_persona_entry(entries, "time_of_day", time_of_day[bucket], name: bucket) if time_of_day.is_a?(Hash)

    weekday = modifiers["weekday"]
    day = weekday_name(now)
    add_persona_entry(entries, "weekday", weekday[day], name: day) if weekday.is_a?(Hash)

    add_persona_entry(entries, "suffix", modifiers["suffix"])
  end

  entries
end

.persona_label_for_key(value, labels) ⇒ Object 



740
741
742
743
744
745
 
# File 'lib/kward/config_files.rb', line 740

def persona_label_for_key(value, labels)
  key = value.to_s.strip
  return nil if key.empty?

  presence(labels[key])
end

.persona_prompt(workspace_root, model: nil, reasoning_effort: nil, now: Time.now, config: read_config) ⇒ String?

Builds persona prompt text from default, workspace, model, reasoning, time-of-day, weekday, and suffix config entries.

Persona resolution is intentionally data-driven so users can edit config without plugin code. Keep new persona selectors additive and deterministic; prompt construction depends on stable ordering.

Parameters:

  • workspace_root (String) —

    active workspace root

  • model (String, nil) (defaults to: nil) —

    active model name

  • reasoning_effort (String, nil) (defaults to: nil) —

    active reasoning effort

  • now (Time) (defaults to: Time.now) —

    local time used for time-based modifiers

  • config (Hash) (defaults to: read_config) —

    parsed config object

Returns:

  • (String, nil) —

    persona prompt text when entries match



589
590
591
592
593
594
595
596
 
# File 'lib/kward/config_files.rb', line 589

def persona_prompt(workspace_root, model: nil, reasoning_effort: nil, now: Time.now, config: read_config)
  text = persona_entries(workspace_root: workspace_root, model: model, reasoning_effort: reasoning_effort, now: now, config: config).map do |entry|
    entry[:prompt]
  end.join("\n\n")
  return nil if text.empty?

  text
end

.plugin_dir ⇒ String

Returns trusted user plugin directory.

Returns:

  • (String) —

    trusted user plugin directory



816
817
818
 
# File 'lib/kward/config_files.rb', line 816

def plugin_dir
  File.expand_path("~/.kward/plugins")
end

.plugin_paths ⇒ Array<String>

Finds trusted top-level plugin files.

Plugins are intentionally loaded only from ~/.kward/plugins, not from a workspace or custom KWARD_CONFIG_PATH directory.

Returns:

  • (Array<String>) —

    sorted plugin file paths



826
827
828
829
830
831
832
833
834
 
# File 'lib/kward/config_files.rb', line 826

def plugin_paths
  plugins_root = plugin_dir
  return [] unless Dir.exist?(plugins_root)

  Dir.glob(File.join(plugins_root, "*.rb")).sort
rescue StandardError => e
  warn "Warning: skipping Kward plugins in #{plugins_root}: #{e.message}"
  []
end

.presence(value) ⇒ Object 



877
878
879
880
 
# File 'lib/kward/config_files.rb', line 877

def presence(value)
  text = value.to_s
  text.empty? ? nil : text
end

.project_browser_icon_theme(config = read_config) ⇒ Object

Returns the project browser icon theme, or off when unset or invalid.



429
430
431
432
433
 
# File 'lib/kward/config_files.rb', line 429

def project_browser_icon_theme(config = read_config)
  browser = config["project_browser"].is_a?(Hash) ? config["project_browser"] : {}
  theme = browser["icons"].to_s
  PROJECT_BROWSER_ICON_THEMES.include?(theme) ? theme : "off"
end

.project_browser_state_path ⇒ Object 



187
188
189
 
# File 'lib/kward/config_files.rb', line 187

def project_browser_state_path
  File.join(cache_dir, "project_browser_state.json")
end

.project_skills_trusted?(config = read_config) ⇒ Boolean

Returns whether project-level Agent Skills should be loaded from the workspace.

Returns:

  • (Boolean) 


502
503
504
505
 
# File 'lib/kward/config_files.rb', line 502

def project_skills_trusted?(config = read_config)
  skills = config["skills"].is_a?(Hash) ? config["skills"] : {}
  skills["trust_project"] == true
end

.prompt_history_path(cwd, config_dir: self.config_dir, kind: "prompt") ⇒ Object 



191
192
193
194
195
196
 
# File 'lib/kward/config_files.rb', line 191

def prompt_history_path(cwd, config_dir: self.config_dir, kind: "prompt")
  key = Digest::SHA256.hexdigest(canonical_workspace_root(cwd))[0, 24]
  return File.join(config_dir, "history", "#{key}.jsonl") if kind.to_s == "prompt"

  File.join(config_dir, "history", kind.to_s, "#{key}.jsonl")
end

.prompt_template_registry ⇒ Object 



865
866
867
868
869
870
871
 
# File 'lib/kward/config_files.rb', line 865

def prompt_template_registry
  Prompts::Templates.new(
    config_dir: config_dir,
    template_class: PromptTemplate,
    markdown_parser: ->(path) { Frontmatter.markdown_parts(path) }
  )
end

.prompt_templates(reserved_commands: []) ⇒ Array<PromptTemplate>

Lists prompt templates exposed as slash commands.

Parameters:

  • reserved_commands (Array<String>) (defaults to: []) —

    command names unavailable to templates

Returns:



840
841
842
 
# File 'lib/kward/config_files.rb', line 840

def prompt_templates(reserved_commands: [])
  prompt_template_registry.prompt_templates(reserved_commands: reserved_commands)
end

.read_config(path = config_path) ⇒ Hash

Reads the JSON config file.

Missing files are treated as an empty config. Invalid JSON raises a user-facing error that includes the file path. This method does not merge defaults; callers should apply feature-specific defaults at the point where behavior is decided.

Parameters:

  • path (String) (defaults to: config_path) —

    config file path

Returns:

  • (Hash) —

    parsed config object



224
225
226
227
228
229
230
231
232
 
# File 'lib/kward/config_files.rb', line 224

def read_config(path = config_path)
  path = File.expand_path(path)
  return {} if skip_config? && path == config_path
  return {} unless File.exist?(path)

  JSON.parse(File.read(path))
rescue JSON::ParserError => e
  raise ConfigError.new(path: path, format: "JSON", detail: e.message)
end

.read_ekwsh_config(path = ekwsh_config_path) ⇒ Object 



311
312
313
314
315
316
317
318
319
 
# File 'lib/kward/config_files.rb', line 311

def read_ekwsh_config(path = ekwsh_config_path)
  path = File.expand_path(path)
  return normalize_ekwsh_config(nil) unless File.exist?(path)

  data = YAML.safe_load(File.read(path), permitted_classes: [], aliases: false)
  normalize_ekwsh_config(data)
rescue Psych::SyntaxError => e
  raise "Invalid ekwsh YAML config: #{path}: #{e.message}"
end

.read_prompt_file(path, label) ⇒ Object 



689
690
691
692
693
694
695
696
697
698
699
700
701
702
 
# File 'lib/kward/config_files.rb', line 689

def read_prompt_file(path, label)
  return nil unless File.exist?(path)

  size = File.size(path)
  if size > MAX_PROMPT_FILE_BYTES
    warn "Warning: skipping #{label} #{path}: file too large (#{size} bytes; limit is #{MAX_PROMPT_FILE_BYTES} bytes)"
    return nil
  end

  File.read(path)
rescue StandardError => e
  warn "Warning: skipping #{label} #{path}: #{e.message}"
  nil
end

.read_skill_file(name, relative_path = nil, workspace_root: Dir.pwd) ⇒ String

Reads a skill file by skill name and optional relative path.

Parameters:

  • name (String) —

    configured skill name

  • relative_path (String, nil) (defaults to: nil) —

    path inside the skill directory

Returns:

  • (String) —

    file contents or an error string



849
850
851
 
# File 'lib/kward/config_files.rb', line 849

def read_skill_file(name, relative_path = nil, workspace_root: Dir.pwd)
  skills_registry(workspace_root: workspace_root).read_skill_file(name, relative_path)
end

.read_trusted_workspace_hooks ⇒ Object 



288
289
290
291
292
293
 
# File 'lib/kward/config_files.rb', line 288

def read_trusted_workspace_hooks
  config = read_config(trusted_workspace_hooks_path)
  config.is_a?(Hash) ? config : {}
rescue ConfigError
  {}
end

.read_trusted_workspace_hooks_config(workspace_root = Dir.pwd) ⇒ Object 



253
254
255
256
257
258
 
# File 'lib/kward/config_files.rb', line 253

def read_trusted_workspace_hooks_config(workspace_root = Dir.pwd)
  path = workspace_hooks_path(workspace_root)
  return {} unless workspace_hooks_trusted?(workspace_root)

  read_config(path)
end

.resolved_persona_text(value, characters: {}) ⇒ Object 



728
729
730
731
732
733
734
735
736
737
738
 
# File 'lib/kward/config_files.rb', line 728

def resolved_persona_text(value, characters: {})
  return nil if value.nil?

  key = value.to_s.strip
  return nil if key.empty?

  text = characters[key.to_s]
  return text unless text.to_s.empty?

  value
end

.session_auto_resume_enabled?(config = read_config) ⇒ Boolean

Returns whether new frontends should resume the last active session automatically.

Returns:

  • (Boolean) 


508
509
510
511
 
# File 'lib/kward/config_files.rb', line 508

def session_auto_resume_enabled?(config = read_config)
  sessions = config["sessions"].is_a?(Hash) ? config["sessions"] : {}
  sessions["auto_resume"] == true
end

.skills(workspace_root: Dir.pwd) ⇒ Array<Skill>

Lists configured skills discovered under the config directory.

Returns:

  • (Array<Skill>) —

    skill metadata available to the model



811
812
813
 
# File 'lib/kward/config_files.rb', line 811

def skills(workspace_root: Dir.pwd)
  skills_registry(workspace_root: workspace_root).skills
end

.skills_registry(workspace_root: Dir.pwd) ⇒ Object 



853
854
855
856
857
858
859
860
861
862
863
 
# File 'lib/kward/config_files.rb', line 853

def skills_registry(workspace_root: Dir.pwd)
  Skills::Registry.new(
    config_dir: config_dir,
    workspace_root: workspace_root,
    project_skills_trusted: project_skills_trusted?,
    skill_class: Skill,
    max_file_bytes: MAX_SKILL_FILE_BYTES,
    markdown_parser: ->(path) { Frontmatter.markdown_parts(path, lenient: true) },
    inside_directory: method(:inside_directory?)
  )
end

.skip_config=(value) ⇒ Object 



70
71
72
 
# File 'lib/kward/config_files.rb', line 70

def skip_config=(value)
  @skip_config = value
end

.skip_config? ⇒ Boolean

Returns:

  • (Boolean) 


74
75
76
 
# File 'lib/kward/config_files.rb', line 74

def skip_config?
  @skip_config == true
end

.time_of_day_bucket(now) ⇒ Object 



795
796
797
798
799
800
801
802
 
# File 'lib/kward/config_files.rb', line 795

def time_of_day_bucket(now)
  hour = now.hour
  return "morning" if hour >= 5 && hour < 11
  return "before_lunch" if hour == 11
  return "late_evening" if hour >= 21 || hour < 5

  nil
end

.trust_workspace_hooks!(workspace_root = Dir.pwd) ⇒ Object 



268
269
270
271
272
273
274
275
 
# File 'lib/kward/config_files.rb', line 268

def trust_workspace_hooks!(workspace_root = Dir.pwd)
  path = workspace_hooks_path(workspace_root)
  raise "No workspace hook config found: #{path}" unless File.file?(path)

  trusted = read_trusted_workspace_hooks
  trusted[File.expand_path(path)] = workspace_hooks_digest(workspace_root)
  PrivateFile.write_json(trusted_workspace_hooks_path, trusted)
end

.trusted_workspace_hooks_path ⇒ Object 



108
109
110
 
# File 'lib/kward/config_files.rb', line 108

def trusted_workspace_hooks_path
  File.join(config_dir, "trusted_workspace_hooks.json")
end

.untrust_workspace_hooks!(workspace_root = Dir.pwd) ⇒ Object 



277
278
279
280
281
282
 
# File 'lib/kward/config_files.rb', line 277

def untrust_workspace_hooks!(workspace_root = Dir.pwd)
  path = File.expand_path(workspace_hooks_path(workspace_root))
  trusted = read_trusted_workspace_hooks
  trusted.delete(path)
  PrivateFile.write_json(trusted_workspace_hooks_path, trusted)
end

.update_check_cache_path ⇒ Object 



183
184
185
 
# File 'lib/kward/config_files.rb', line 183

def update_check_cache_path
  File.join(cache_dir, "update_check.json")
end

.update_config(values, path = config_path) ⇒ Object

Merges top-level config values and writes the updated config privately.



375
376
377
378
379
380
381
382
 
# File 'lib/kward/config_files.rb', line 375

def update_config(values, path = config_path)
  raise "Config values must be an object" unless values.is_a?(Hash)

  config = read_config(path)
  values.each { |key, value| config[key.to_s] = value }
  write_config(config, path)
  config
end

.update_nested_config(section, values, path = config_path) ⇒ Object

Merges values into a one-level nested config section and writes privately.



385
386
387
388
389
390
391
392
393
 
# File 'lib/kward/config_files.rb', line 385

def update_nested_config(section, values, path = config_path)
  raise "Config values must be an object" unless values.is_a?(Hash)

  config = read_config(path)
  current = config[section.to_s].is_a?(Hash) ? config[section.to_s].dup : {}
  config[section.to_s] = current.merge(values.transform_keys(&:to_s))
  write_config(config, path)
  config
end

.update_overlay_settings(values) ⇒ Object

Validates and persists terminal overlay settings.



532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
 
# File 'lib/kward/config_files.rb', line 532

def update_overlay_settings(values)
  raise "Overlay settings must be an object" unless values.is_a?(Hash)

  config = read_config
  overlay = overlay_settings(config)
  values.each do |key, value|
    key = key.to_s
    value = value.to_s
    case key
    when "alignment"
      raise "Overlay alignment must be left, center, or right" unless OVERLAY_ALIGNMENTS.include?(value)
    when "width"
      raise "Overlay width must be capped or maximum" unless OVERLAY_WIDTHS.include?(value)
    else
      raise "Unknown overlay setting: #{key}"
    end
    overlay[key] = value
  end
  config["overlay"] = overlay
  write_config(config)
  overlay_settings(config)
end

.web_search_config(config = read_config) ⇒ Object

Returns the nested web-search config object, or an empty config when absent.



520
521
522
523
 
# File 'lib/kward/config_files.rb', line 520

def web_search_config(config = read_config)
  value = config["web_search"]
  value.is_a?(Hash) ? value : {}
end

.weekday_name(now) ⇒ Object 



804
805
806
 
# File 'lib/kward/config_files.rb', line 804

def weekday_name(now)
  %w[sunday monday tuesday wednesday thursday friday saturday][now.wday]
end

.workspace_agents_file?(workspace_root) ⇒ Boolean

Returns:

  • (Boolean) 


681
682
683
 
# File 'lib/kward/config_files.rb', line 681

def workspace_agents_file?(workspace_root)
  File.exist?(workspace_agents_path(workspace_root))
end

.workspace_agents_path(workspace_root) ⇒ Object 



677
678
679
 
# File 'lib/kward/config_files.rb', line 677

def workspace_agents_path(workspace_root)
  File.join(canonical_workspace_root(workspace_root), "AGENTS.md")
end

.workspace_agents_prompt(workspace_root) ⇒ Object 



685
686
687
 
# File 'lib/kward/config_files.rb', line 685

def workspace_agents_prompt(workspace_root)
  read_prompt_file(workspace_agents_path(workspace_root), "workspace AGENTS.md")
end

.workspace_guardrails_enabled?(config = read_config) ⇒ Boolean

Returns whether file tools must stay inside the active workspace root.

Returns:

  • (Boolean) 


491
492
493
494
 
# File 'lib/kward/config_files.rb', line 491

def workspace_guardrails_enabled?(config = read_config)
  tools = config["tools"].is_a?(Hash) ? config["tools"] : {}
  tools["workspace_guardrails"] != false
end

.workspace_hooks_digest(workspace_root = Dir.pwd) ⇒ Object 



284
285
286
 
# File 'lib/kward/config_files.rb', line 284

def workspace_hooks_digest(workspace_root = Dir.pwd)
  Digest::SHA256.file(workspace_hooks_path(workspace_root)).hexdigest
end

.workspace_hooks_path(root = Dir.pwd) ⇒ Object 



104
105
106
 
# File 'lib/kward/config_files.rb', line 104

def workspace_hooks_path(root = Dir.pwd)
  File.join(File.expand_path(root), ".kward", "hooks.json")
end

.workspace_hooks_trusted?(workspace_root = Dir.pwd) ⇒ Boolean

Returns:

  • (Boolean) 


260
261
262
263
264
265
266
 
# File 'lib/kward/config_files.rb', line 260

def workspace_hooks_trusted?(workspace_root = Dir.pwd)
  path = workspace_hooks_path(workspace_root)
  return false unless File.file?(path)

  trusted = read_trusted_workspace_hooks
  trusted[File.expand_path(path)] == workspace_hooks_digest(workspace_root)
end

.write_config(config, path = config_path) ⇒ Object

Writes config JSON using private file permissions.

Parameters:

  • config (Hash) —

    config object to persist

  • path (String) (defaults to: config_path) —

    config file path



238
239
240
241
242
243
 
# File 'lib/kward/config_files.rb', line 238

def write_config(config, path = config_path)
  path = File.expand_path(path)
  raise "Cannot write Kward config while --skip-config is active: #{path}" if skip_config? && path == config_path

  PrivateFile.write_json(path, config)
end