Files
albert-gitmoji/README.md
2026-03-01 11:07:10 +01:00

61 lines
1.1 KiB
Markdown

# Gitmoji Picker for Albert
A fast and efficient C++ implementation of the Gitmoji picker for Albert launcher.
## Features
- Search gitmojis by name or description
- Copy either emoji or gitmoji code to clipboard
- Configurable copy format via settings
- Fast indexing and fuzzy search
- Native Albert C++ plugin
## Installation
### Building from source
```bash
mkdir build && cd build
cmake ..
cmake --build .
```
### Installation
Copy the built library to your Albert plugins directory:
```bash
# Local installation
cp build/libgitmoji.so ~/.local/lib/albert/
# Or system-wide
sudo cp build/libgitmoji.so /usr/lib/albert/
```
## Usage
Trigger the plugin with `g:` followed by your search query.
Examples:
- `g:bug` - Search for bug-related gitmojis
- `g:*` - Show all gitmojis
- `g:deploy` - Search for deployment-related gitmojis
## Configuration
Access the plugin settings in Albert to choose what to copy:
- **Emoji**: Copy the emoji character (e.g., 🎨)
- **Gitmoji code**: Copy the code (e.g., :art:)
## Development
This plugin uses:
- Albert C++ API
- Qt6 framework
- CMake build system
- IndexQueryHandler for efficient search
## License
MIT