feat(tui): add vim-like keybinds and settings tab for config edit
This commit is contained in:
54
README.md
54
README.md
@@ -2,13 +2,17 @@
|
||||
|
||||
A Terminal User Interface (TUI) for managing Sonarr.
|
||||
|
||||
> ✨ **Note**: This project was fully vibe coded with AI assistance, showcasing modern development workflows and comprehensive feature implementation.
|
||||
|
||||
## Features
|
||||
|
||||
- View system status and health
|
||||
- Browse series and episodes
|
||||
- Monitor download queue
|
||||
- View download history
|
||||
- Interactive TUI interface
|
||||
- Interactive TUI interface with vim-like keybind support
|
||||
- Configurable UI preferences and keybind modes
|
||||
- In-app configuration editing for Sonarr connection and UI settings
|
||||
- Configurable via config files, environment variables, or CLI arguments
|
||||
|
||||
## Installation
|
||||
@@ -39,6 +43,12 @@ Example configuration:
|
||||
[sonarr]
|
||||
url = "http://localhost:8989"
|
||||
api_key = "your-api-key-here"
|
||||
|
||||
[ui]
|
||||
# Keybind mode: "Normal" or "Vim"
|
||||
keybind_mode = "Normal"
|
||||
# Show help text in footer
|
||||
show_help = true
|
||||
```
|
||||
|
||||
### Environment Variables
|
||||
@@ -48,6 +58,8 @@ Set these environment variables:
|
||||
```bash
|
||||
export YARR_SONARR_URL="http://localhost:8989"
|
||||
export YARR_SONARR_API_KEY="your-api-key-here"
|
||||
export YARR_UI_KEYBIND_MODE="Vim"
|
||||
export YARR_UI_SHOW_HELP="true"
|
||||
```
|
||||
|
||||
### Command Line Arguments
|
||||
@@ -134,11 +146,49 @@ yarr completions powershell > yarr.ps1
|
||||
|
||||
## TUI Controls
|
||||
|
||||
### Normal Mode (Default)
|
||||
|
||||
- `q` - Quit
|
||||
- `↑/↓` or `j/k` - Navigate up/down
|
||||
- `Enter` - Select/expand
|
||||
- `Tab` - Switch between panels
|
||||
- `Tab` - Switch between tabs
|
||||
- `d` - Toggle details
|
||||
- `r` - Refresh data
|
||||
- `/` - Search (in Search tab)
|
||||
- `s` - Save configuration changes
|
||||
|
||||
### Vim Mode
|
||||
|
||||
- `q` - Quit
|
||||
- `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
|
||||
- `s` - Save configuration changes
|
||||
|
||||
### Settings Tab
|
||||
|
||||
Use the Settings tab to:
|
||||
- Toggle between Normal and Vim keybind modes
|
||||
- Enable/disable help text display
|
||||
- Edit Sonarr server URL and API key
|
||||
- Save configuration changes to file
|
||||
|
||||
Access the Settings tab by navigating to the last tab or pressing `Tab` repeatedly.
|
||||
|
||||
### In-App Configuration
|
||||
|
||||
You can configure Sonarr connection settings directly within the application:
|
||||
1. Navigate to the Settings tab
|
||||
2. Select "Sonarr URL" or "API Key" and press Enter
|
||||
3. Type the new value and press Enter to save
|
||||
4. Press 's' to save all changes to the config file
|
||||
|
||||
This eliminates the need to manually edit config files for basic setup.
|
||||
|
||||
## Getting Started
|
||||
|
||||
|
||||
Reference in New Issue
Block a user