https://github.com/codervijo/journalview
JournalView is a lightweight, terminal-based application written in Rust that allows users to efficiently view, filter, and navigate system logs from journalctl.
https://github.com/codervijo/journalview
journalctl ratatui rust tui tui-rs
Last synced: about 2 months ago
JSON representation
JournalView is a lightweight, terminal-based application written in Rust that allows users to efficiently view, filter, and navigate system logs from journalctl.
- Host: GitHub
- URL: https://github.com/codervijo/journalview
- Owner: codervijo
- Created: 2024-12-30T20:01:22.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2025-01-30T16:25:21.000Z (3 months ago)
- Last Synced: 2025-01-30T17:29:08.934Z (3 months ago)
- Topics: journalctl, ratatui, rust, tui, tui-rs
- Language: Rust
- Homepage:
- Size: 99.6 KB
- Stars: 25
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-ratatui - journalview - Journalctl log viewer. (💻 Apps / 👨💻 System Administration)
README
# JournalView
A lightweight, terminal-based application written in Rust for efficiently viewing, filtering, and navigating system logs from `journalctl`.
## Features
- **Log Viewing**: Access logs from `journalctl` logs.
- **Filtering**: Powerful filtering capabilities
- **Keyboard Navigation**: Intuitive hotkeys for seamless log exploration.
- **Customizable View**: Adjust the display for better readability.
## Installation
### Install Directly (Without Building from Source)
```
curl -sL https://github.com/codervijo/journalview/raw/main/install.sh | bash
```
### Build From Source
#### Prerequisites
- **Rust**: Ensure Rust is installed. You can install Rust using [rustup](https://rustup.rs/).
#### Clone the Repository
```bash
git clone https://github.com/codervijo/journalview.git
cd journalview
```
#### Build the Application
```bash
cargo build --release
```
#### Run the Application
```bash
./target/release/journalview
```
## Usage
### Basic Commands
- Launch the application:
```bash
journalview
```
- Navigate logs using arrow keys or predefined hotkeys.
### Filtering Logs
- Press `/` to enter a search query (regex supported).
- Use `Tab` to switch between different log sources.
### Hotkeys
| Key | Action |
|------------|------------------------------|
| `Arrow Up` | Scroll up in the log list |
| `Arrow Down` | Scroll down in the log list |
| `Enter` | Select a log entry |
| `/` | Start a search |
| `q` | Quit the application |
## Contributing
Contributions are welcome! Follow these steps to contribute:
1. Fork the repository.
2. Create a feature branch:
```bash
git checkout -b feature-name
```
3. Commit your changes:
```bash
git commit -m "Description of changes"
```
4. Push to your fork:
```bash
git push origin feature-name
```
5. Open a Pull Request.
## Acknoweldgements
Thanks to the following projects for inspiration
- [Ratatui](https://github.com/ratatui/ratatui)
- [Lazyjournal](https://github.com/Lifailon/lazyjournal)
## License
This project is licensed under the [MIT License](LICENSE).
## Acknowledgments
Inspired by the functionality of `journalctl` and enhanced by the capabilities of Rust for high-performance, terminal-based tools.