Add README
This commit is contained in:
1 parent
303c56f03d
commit
64b6b1454b
1 file changed
+86
@@ -0,0 +1,86 @@
|
|||||||
|
# quoter
|
||||||
|
|
||||||
|
Random quotes from movies, TV shows, and games — a bash CLI with SQLite and fzf TUI.
|
||||||
|
|
||||||
|
## Features
|
||||||
|
|
||||||
|
- **Random quote** — just run `quoter`
|
||||||
|
- **List & filter** — by source, character, or type (movie/tv/game)
|
||||||
|
- **Search** — across quote text, character names, and source titles
|
||||||
|
- **Interactive TUI** — browse, add, and delete quotes with fzf
|
||||||
|
- **Import** — load custom quotes from SQL files
|
||||||
|
- **Simple mode** — minimal output for scripting/pipes
|
||||||
|
|
||||||
|
## Install
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# User install (default: ~/.local/bin)
|
||||||
|
./install.sh --user
|
||||||
|
|
||||||
|
# System install (requires sudo)
|
||||||
|
./install.sh --system
|
||||||
|
|
||||||
|
# Uninstall
|
||||||
|
./install.sh --uninstall
|
||||||
|
```
|
||||||
|
|
||||||
|
### Dependencies
|
||||||
|
|
||||||
|
- **sqlite3** — required
|
||||||
|
- **fzf** — optional, for interactive TUI and browsing
|
||||||
|
- **gum** — optional, for styled display
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# Random quote
|
||||||
|
quoter
|
||||||
|
|
||||||
|
# Simple output (no box)
|
||||||
|
quoter --simple
|
||||||
|
|
||||||
|
# List all quotes
|
||||||
|
quoter --list
|
||||||
|
|
||||||
|
# Filter by type
|
||||||
|
quoter --list --type movie
|
||||||
|
quoter --list --type tv
|
||||||
|
quoter --list --type game
|
||||||
|
|
||||||
|
# Filter by character or source
|
||||||
|
quoter --list --character Butcher
|
||||||
|
quoter --list --source "Game of Thrones"
|
||||||
|
|
||||||
|
# Search across quotes, characters, and sources
|
||||||
|
quoter --search "power"
|
||||||
|
quoter --search "Butcher"
|
||||||
|
|
||||||
|
# Add a quote (interactive)
|
||||||
|
quoter --add
|
||||||
|
|
||||||
|
# Add a quote (non-interactive)
|
||||||
|
quoter --add -q "I am Iron Man." -s "Iron Man" -c "Tony Stark" -t movie
|
||||||
|
|
||||||
|
# Delete a quote
|
||||||
|
quoter --delete # fzf picker
|
||||||
|
quoter --delete 5 # by ID
|
||||||
|
|
||||||
|
# Browse quotes interactively (requires fzf)
|
||||||
|
quoter --browse
|
||||||
|
|
||||||
|
# Launch TUI (requires fzf)
|
||||||
|
quoter --tui
|
||||||
|
|
||||||
|
# Import quotes from a SQL file
|
||||||
|
quoter --import my_quotes.sql
|
||||||
|
```
|
||||||
|
|
||||||
|
## Data
|
||||||
|
|
||||||
|
- Quotes stored in `~/.local/share/quoter/quoter.db`
|
||||||
|
- Default seed data from `quotes.sql` (96 quotes)
|
||||||
|
- Franchises: The Boys, Breaking Bad, The Dark Knight, MCU, Lord of the Rings, Game of Thrones, classic games
|
||||||
|
|
||||||
|
## License
|
||||||
|
|
||||||
|
MIT
|
||||||
Reference in new issue
Block a user