yarr/KEYBINDS.md

Keybind Reference

Yarr supports two keybind modes: Normal (default) and Vim. You can switch between modes in the Settings tab or by configuring it in your config file.

Configuration

Via Config File

[ui]
keybind_mode = "Vim"  # or "Normal"
show_help = true

Via Environment Variable

export YARR_UI_KEYBIND_MODE="Vim"

Via Settings Menu

1. Navigate to the Settings tab (last tab)
2. Use arrow keys or navigation keys to select "Keybind Mode"
3. Press Enter to toggle between Normal and Vim modes
4. Press 's' to save changes

Normal Mode (Default)

Navigation

Key	Action
↑ / k	Move up
↓ / j	Move down
Tab	Next tab
Shift+Tab	Previous tab

Actions

Key	Action
q	Quit application
r	Refresh/reload data
d	Toggle details view
/	Enter search mode (Search tab only)
Enter	Select/activate item
Esc	Cancel/clear error/exit search
s	Save configuration changes

Search Mode (Search Tab)

Key	Action
Enter	Execute search
Esc	Exit search mode
Backspace	Delete character
Any character	Add to search term

Vim Mode

Navigation

Key	Action
h	Move left / Previous tab
j	Move down
k	Move up
l	Move right / Next tab
w	Next tab (word forward)
b	Previous tab (word backward)
gg	Go to first item
G	Go to last item

Actions

Key	Action
q	Quit application
u	Refresh/reload data (undo)
v	Toggle details view (visual mode)
/	Enter search mode
i	Enter insert/input mode (search)
Enter	Select/activate item
Esc	Cancel/clear error/exit modes
s	Save configuration changes

Insert/Search Mode (Vim)

Key	Action
Enter	Execute search
Esc	Exit insert/search mode
Backspace	Delete character
Any character	Add to search term

Tab Navigation

Both modes support the following tabs:

1. Series - View all series
2. Search - Search for new series
3. Calendar - Upcoming episodes
4. Queue - Download queue
5. History - Download history
6. Health - System health status
7. Settings - Configure application settings

Settings Tab

The Settings tab allows you to:

• Toggle between Normal and Vim keybind modes
• Enable/disable help text display
• Edit Sonarr server URL
• Edit Sonarr API key
• Save configuration changes to file

Settings Navigation

Key	Action
↑/↓ or j/k	Navigate settings options
Enter	Toggle setting or edit Sonarr config
s	Save all changes to config file

Editing Sonarr Configuration

When editing URL or API key:

Key	Action
Enter	Save changes and return to settings
Esc	Cancel editing and return to settings
Any character	Type new value
Backspace	Delete character

Tips

1. Vim Mode Features: Vim mode includes additional navigation shortcuts like gg for first item and G for last item.

2. Help Display: Enable "Show Help" in settings to see keybind hints in the footer.

3. Configuration Persistence: Use the 's' key to save any settings changes. Unsaved changes are indicated in the Settings tab title.

4. Mode Switching: You can switch between keybind modes anytime via the Settings tab without restarting the application.

5. Fallback Keys: Most vim keys have fallback arrow key equivalents, and most normal mode keys work in vim mode too.

Examples

Switching to Vim Mode

1. Navigate to Settings tab: Tab (repeatedly until you reach Settings)
2. Select keybind mode: ↓ or j (if not already selected)
3. Toggle to Vim: Enter
4. Save changes: s

Configuring Sonarr Connection

1. Navigate to Settings tab: Tab (repeatedly until you reach Settings)
2. Select "Sonarr URL": ↓ or j to navigate
3. Edit URL: Enter, type new URL, Enter to save
4. Select "API Key": ↓ or j to navigate
5. Edit API Key: Enter, type new key, Enter to save
6. Save changes: s

Quick Navigation in Vim Mode

• Jump to first series: gg (in Series tab)
• Jump to last item: G
• Switch to next tab: w or l
• Refresh data: u
• Search: / (in Search tab) or i (in Search tab)

Search Workflow

1. Go to Search tab: Tab (navigate to Search)
2. Enter search mode: / (Normal) or i (Vim)
3. Type search term: any characters
4. Execute search: Enter
5. Navigate results: ↑/↓ or j/k