Config and customization documentation.

[theantichris]

Where can I find this? The help says "Read customize /view.md" but that file is not present. It also mentions config.yml but I'm not sure what options are available.

[boolean-maybe]

hey @theantichris , when you see links like this in the help or a doc you can select it with Tab (gets highlighted):

and open with Enter. That will take you to the link:

as far as config.yaml it's currently in the same dir as the actual executable (which tiki). The plugin definition files are also supposed to be there (heads-up - the config location is going to change very soon to adhere to standards (~/.config/tiki/ on Mac and Linux, see #15)

[theantichris]

I appreciate the dir change! I found the config file, are the default options the only configuration values currently?

[boolean-maybe]

here's the full option set as of now:

# =============================================================================
# TIKI Configuration File
# =============================================================================
# Location: same directory as the tiki binary, or current working directory
# Environment variables can override any setting using TIKI_ prefix
# Example: TIKI_LOGGING_LEVEL=debug overrides logging.level
# =============================================================================

# -----------------------------------------------------------------------------
# Logging Configuration
# -----------------------------------------------------------------------------
logging:
    level: error        # Options: debug, info, warn, error (default: error)
    # Can also be set via --log-level flag

# -----------------------------------------------------------------------------
# Header Bar Configuration
# -----------------------------------------------------------------------------
header:
    visible: true       # Show/hide header bar (default: true)
    # Toggle with F10 at runtime

# -----------------------------------------------------------------------------
# Tiki (Task) Configuration
# -----------------------------------------------------------------------------
tiki:
    maxPoints: 10       # Maximum story points value (default: 10, minimum: 1)

# -----------------------------------------------------------------------------
# Appearance Configuration
# -----------------------------------------------------------------------------
appearance:
    theme: auto         # Options: dark, light, auto (default: auto)
    # "auto" detects from COLORFGBG env var

# -----------------------------------------------------------------------------
# Board Configuration (deprecated - use plugins instead)
# -----------------------------------------------------------------------------
board:
    view: expanded      # Options: compact, expanded

# -----------------------------------------------------------------------------
# Plugins Configuration
# -----------------------------------------------------------------------------
# Plugins can be defined inline, referenced from files, or hybrid (both)
# Plugins with same name as embedded ones merge/override embedded settings
#
# Embedded plugins (always available):
#   - Backlog (F3)
#   - Recent (Ctrl+R)
#   - Roadmap (F2)
#   - Documentation (F1)
#   - Help (?)
# -----------------------------------------------------------------------------
plugins:
    # ---------------------------------------------------------------------------
    # Example 1: File-based plugin reference
    # ---------------------------------------------------------------------------
    - file: my-plugin.yaml    # Path relative to binary directory
    
    # ---------------------------------------------------------------------------
    # Example 2: Inline tiki plugin (task-based view)
    # ---------------------------------------------------------------------------
    - name: My Backlog
      type: tiki              # Plugin type: tiki (default) or doki
      foreground: "#5fff87"   # Hex color or named color (white, red, etc.)
      background: "#005f00"
      key: "F4"               # Activation key: F1-F12, Ctrl-X, or single char
      sort: Priority, ID      # Sort rules: field names, optionally with DESC
      view: expanded          # View mode: compact or expanded
      panes:
          - name: Ready
            columns: 2          # Number of columns for this pane (default: 1)
            filter: status = 'todo'
            action: status = 'todo'   # Applied when task moved to this pane
          - name: In Progress
            columns: 2
            filter: status = 'in progress'
            action: status = 'in progress'
    
    # ---------------------------------------------------------------------------
    # Example 3: Inline doki plugin (documentation view)
    # ---------------------------------------------------------------------------
    - name: Architecture
      type: doki
      foreground: "#ffff99"
      background: "#996600"
      key: "F6"
      fetcher: file           # Options: file, internal
      url: architecture/index.md  # Path to markdown file (for fetcher: file)
        # text: "# Inline content"  # Markdown content (for fetcher: internal)
    
    # ---------------------------------------------------------------------------
    # Example 4: Override embedded plugin
    # ---------------------------------------------------------------------------
    - name: Board             # Overrides the default board
      view: compact           # Change default view mode
    
    # ---------------------------------------------------------------------------
    # Example 5: Hybrid - file + inline overrides
    # ---------------------------------------------------------------------------
    - file: roadmap.yaml
      view: expanded          # Override the view mode from file
      key: "F5"               # Override the key binding from file