https://github.com/rae-api-com/rae-tui
Command utility to interact with rae-api.com API from the terminal
https://github.com/rae-api-com/rae-tui
rae terminal tui
Last synced: 12 months ago
JSON representation
Command utility to interact with rae-api.com API from the terminal
- Host: GitHub
- URL: https://github.com/rae-api-com/rae-tui
- Owner: rae-api-com
- Created: 2025-03-29T15:02:19.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-03-29T17:21:33.000Z (about 1 year ago)
- Last Synced: 2025-03-29T18:27:39.502Z (about 1 year ago)
- Topics: rae, terminal, tui
- Language: Go
- Homepage: https://rae-api.com
- Size: 3.67 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# RAE-TUI
A terminal-based Spanish dictionary client for the Royal Spanish Academy (Real Academia Española - RAE).
## Features
- Look up Spanish words directly from your terminal
- View detailed definitions and meanings
- Interactive TUI (Terminal User Interface) with keyboard navigation
- Display verb conjugations in all tenses
- Non-interactive CLI mode for quick lookups
- No API key required
## Installation
### From Source
```bash
go install github.com/rae-api-com/rae-tui@latest
```
### Binary Releases
Download the appropriate binary for your platform from the [Releases](https://github.com/rae-api-com/rae-tui/releases) page.
## Usage
### Interactive TUI Mode
Launch the interactive TUI:
```bash
rae-tui
# or
rae-tui tui
```
With a specific word:
```bash
rae-tui tui palabra
```
### CLI Mode
Lookup a word directly:
```bash
rae palabra
```
### Keyboard Shortcuts (TUI Mode)
- `↑`/`k`: Move selection up
- `↓`/`j`: Move selection down
- `n`: Search for a new word
- `q`/`ESC`: Exit or go back
- `ENTER`: Select
## License
MIT License
## Acknowledgements
- [go-rae](https://github.com/rae-api-com/go-rae) - Go client for the RAE API
- [tview](https://github.com/rivo/tview) - Terminal UI library
- [Terminalizer](https://terminalizer.com/) - Used for creating demo GIFs