# gitlogue
<p align="center">
<img src="docs/assets/demo.gif" alt="gitlogue demo" style="max-width: 100%; width: 800px;" />
</p>
A cinematic Git commit replay tool for the terminal, turning your Git history into a living, animated story.
Watch commits unfold with realistic typing animations, syntax highlighting, and file tree transitions, transforming code changes into a visual experience.
## Installation
### Using Install Script (Recommended)
```bash
### Using Homebrew
```bash
brew install unhappychoice/tap/gitlogue
```
### Using Cargo
```bash
cargo install gitlogue
```
### From Source
```bash
git clone https://github.com/unhappychoice/gitlogue.git
cd gitlogue
cargo install --path .
```
See the [Installation Guide](docs/installation.md) for more options and troubleshooting.
## Features
🎬 **Commit Replay as Animation** — Realistic typing, cursor movement, deletions, and file operations
🎨 **Tree-sitter Syntax Highlighting** — 26 languages supported
🌳 **Project File Tree** — Directory structure with change statistics
🖥️ **Screensaver Mode** — Endless random commit playback
🎭 **Themes** — 9 built-in themes + full customization support
⚡ **Fast & Lightweight** — Built with Rust for performance
## Usage
### Popular Use Cases
🖥️ **Screensaver** — Ambient coding display for your workspace
🎓 **Education** — Visualize how code evolved over time
📺 **Presentations** — Replay real commit histories live
🎬 **Content Creation** — Record demos with VHS or asciinema
🎨 **Desktop Ricing** — A living decoration for your terminal
💼 **Look Busy Mode** — Appear productive during meetings
### Quick Start
```bash
# Start the cinematic screensaver
gitlogue
# View a specific commit
gitlogue --commit abc123
# Use a different theme
gitlogue --theme dracula
# Adjust typing speed (ms per character)
gitlogue --speed 20
# List available themes
gitlogue theme list
# Set default theme
gitlogue theme set dracula
# Combine options
gitlogue --commit HEAD~5 --theme nord --speed 15
```
## Configuration
gitlogue can be configured via `~/.config/gitlogue/config.toml`.
You can set the default theme, typing speed, and background preferences.
See the [Configuration Guide](docs/configuration.md) for full options and examples.
## Supported Languages
Rust, TypeScript, JavaScript, Python, Go, Ruby, Swift, Kotlin, Java, PHP, C#, C, C++, Haskell, Dart, Scala, Clojure, Zig, Elixir, Erlang, HTML, CSS, JSON, Markdown, YAML, XML
## Documentation
[Installation Guide](docs/installation.md)
[Usage Guide](docs/usage.md)
[Configuration Guide](docs/configuration.md)
[Theme Customization](docs/themes.md)
[Contributing Guidelines](docs/CONTRIBUTING.md)
[Architecture Overview](docs/ARCHITECTURE.md)
## Related Projects
### Git Visualization & Coding
- [**GitType**](https://github.com/unhappychoice/gittype) - A CLI code-typing game that turns your source code into typing challenges
### Terminal Screensavers
- [**tarts**](https://github.com/oiwn/tarts) - Collection of terminal screensavers in Rust (Matrix, Game of Life, Boids, 3D effects, and more)
- [**cbonsai**](https://gitlab.com/jallbrit/cbonsai) - Grow beautiful bonsai trees in your terminal
- [**asciiquarium**](https://github.com/cmatsuoka/asciiquarium) - Enjoy the mysteries of the sea from your terminal
- [**cmatrix**](https://github.com/abishekvashok/cmatrix) - The Matrix screensaver effect for your terminal
- [**pipes.sh**](https://github.com/pipeseroni/pipes.sh) - Animated pipes flowing through your terminal
## Contributing
Contributions are welcome.
See the [Contributing Guidelines](docs/CONTRIBUTING.md) for details.
## License
ISC License. See [LICENSE](LICENSE) for details.
## Author
[@unhappychoice](https://github.com/unhappychoice)