Skip to content

README.md

Latest commit

 

History

History
122 lines (81 loc) · 5.98 KB

README.md

File metadata and controls

122 lines (81 loc) · 5.98 KB

Be My Eyes

GitHub Release Build and Test Build Linux Build macOS Publish to Homebrew Reka AI

A Terminal User Interface (TUI) for analyzing/ summarizing/ questioning / searching into videos. Simply add a video into Be My Eyes let AI watch it, then ask anything you want about that video!

Be My Eyes uses Reka Vision API and is 100% compatible with the free tier API key.

be-my-eye app running in the terminal

Features

  • 🎬 Video Library Management: Browse your indexed videos from the Reka API
  • ❓ Interactive Q&A: Ask questions about video content using AI
  • 📜 Query History: Review past questions and answers
  • 💾 Local Storage: SQLite database for persistent query history
  • 🎨 Beautiful TUI: Clean interface built with Bubble Tea

Installation

You can install Be My Eyes using Homebrew on macOS/Linux or via a .deb package for Debian/Ubuntu. Install via pacman is on the todo list (haapy to get PRs!).

Homebrew (macOS/Linux)

brew tap fboucher/tap
brew install be-my-eyes

APT (Debian/Ubuntu)

Download the .deb file from the latest release and install:

sudo apt install be-my-eyes_*_amd64.deb

Configuration

Before running the application, you need to configure your Reka API key, get yours at here 🔑. Then you can use one of the following options.

Option 1: Environment Variable

export REKA_API_KEY=your_api_key_here

Option 2: Configuration File (Recommended)

The application will automatically save your API key from the environment variable to ~/.config/be-my-eyes/config.json on first run. Alternatively, create it manually:

{
  "api_key": "your_api_key_here"
}

Usage

Run the application:

be-my-eyes

Key Bindings

Main View

Key Action
q Quit the application
r Refresh video library from API
a Ask a question about the selected video
x Open the menu
? Show help screen
tab Switch between sections (Videos → History → Videos)
↑ / ↓ Navigate up/down in lists
j / k Navigate up/down (Vim-style)
enter Select an item
ctrl+c Force quit

Question Dialog

Key Action
ctrl+s Submit the question
esc Cancel and return to main view

Menu, Help, About Screens

Key Action
esc Return to main view
enter Execute selected menu action
↑ / ↓ Navigate menu items

Development

Have a look at DEVELOPER.md for more information on building from source and the project structure.

Contributing

Contributions are welcome! Please see CONTRIBUTING.md for guidelines.

References

Support

This is at a demo stage. If you encounter any issues or have questions, please open an issue on GitHub.

License

MIT License - see LICENSE for details