Files
yarr/yarr-vim.toml.example
uttarayan21 03fd2de38f
Some checks failed
build / checks-matrix (push) Has been cancelled
build / checks-build (push) Has been cancelled
build / codecov (push) Has been cancelled
docs / docs (push) Has been cancelled
feat(yarr): restructure into workspace with separate API and CLI crates
2025-10-08 17:02:34 +05:30

53 lines
1.7 KiB
Plaintext

# Yarr Configuration File - Vim Mode Example
# Copy this file to one of the following locations:
# - ./yarr.toml (current directory)
# - ~/.config/yarr/config.toml (user config directory)
[sonarr]
# Sonarr server URL (required)
# Example: "http://localhost:8989" or "https://sonarr.example.com"
# Can also be edited from the Settings tab in the application
url = "http://localhost:8989"
# Sonarr API key (required)
# You can find this in Sonarr under Settings > General > Security > API Key
# Can also be edited from the Settings tab in the application
api_key = "your-api-key-here"
[ui]
# Keybind mode: "Normal" or "Vim"
# This example shows vim mode configuration
# Can be toggled from the Settings tab in the application
keybind_mode = "Vim"
# Show help text in the footer
# Can be toggled from the Settings tab in the application
show_help = true
# Vim Mode Keybinds:
# - h/j/k/l: Navigate left/down/up/right
# - w/b: Next/previous tab
# - gg: Go to first item
# - G: Go to last item
# - v: Toggle details (visual mode)
# - u: Refresh data (undo)
# - /: Search mode
# - i: Insert/input mode (search)
# - s: Save configuration changes
# - q: Quit
# All settings including Sonarr URL and API key can be changed in the Settings tab:
# 1. Launch yarr and navigate to the Settings tab (last tab)
# 2. Use vim navigation (j/k) to select a setting
# 3. Press Enter to edit Sonarr URL/API key or toggle other options
# 4. Press 's' to save changes
# Environment variables can also be used:
# YARR_SONARR_URL="http://localhost:8989"
# YARR_SONARR_API_KEY="your-api-key-here"
# YARR_UI_KEYBIND_MODE="Vim"
# YARR_UI_SHOW_HELP="true"
#
# Command line arguments take highest priority:
# yarr --sonarr-url="http://localhost:8989" --sonarr-api-key="your-key"