Skip to content

Commit 87ed843

Browse files
committed
update example for scroll and info systems list
1 parent 33cc4c0 commit 87ed843

File tree

2 files changed

+22
-41
lines changed

2 files changed

+22
-41
lines changed

README.md

Lines changed: 22 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -16,31 +16,17 @@ This tool is inspired by and with love for [LazyDocker](https://github.com/jesse
1616

1717
![interface](/img/fuzzy.jpg)
1818

19-
- [Functional](#functional)
20-
- [Roadmap](#roadmap)
21-
- [Install](#install)
22-
- [Unix-based](#unix-based)
23-
- [Arch Linux](#arch-linux)
24-
- [Windows](#windows)
25-
- [Go Package](#go-package)
26-
- [Others](#others)
27-
- [Usage](#usage)
28-
- [Build](#build)
29-
- [Hotkeys](#hotkeys)
30-
- [Contributing](#contributing)
31-
- [Alternatives](#alternatives)
32-
- [License](#license)
33-
3419
## Functional
3520

36-
- Simple installation, to run it, just download a single executable file without dependencies.
21+
- Simple installation, to run just download one executable file without any dependencies.
3722
- List of all units (services, sockets, etc.) via `systemctl` with current running status.
3823
- View all system and user journals via `journalctl` (tool for reading logs from [systemd-journald](https://github.com/systemd/systemd/tree/main/src/journal)).
3924
- List of all system boots for kernel log output.
40-
- File system logs (example, for Apache or Nginx), as well as `syslog` or `messages`, `dmesg` (kernel), etc.
25+
- File system logs (example, for `Apache` or `Nginx`), as well as `syslog` or `messages`, `dmesg` (kernel), etc.
4126
- List of all log files of descriptors used by processes, as well as all log files in the home directories of users.
42-
- Reading archived logs (`gz`, `xz` or `bz2` format) and packet capture files (`pcap` format).
43-
- Docker containers, Podman pods and Swarm services logs.
27+
- Reading archived logs (`gz`, `xz` or `bz2` format), packet capture (`pcap` format) and Apple System Log (`asl` format).
28+
- Docker containers, Podman pods and Swarm services logs (including offline).
29+
- Filtering lists to find the desired journal.
4430
- Displays the currently selected log and filters output in real-time.
4531

4632
Supports 3 filtering modes:
@@ -59,28 +45,22 @@ Supported coloring groups for output:
5945
- **Purple** - url and full paths in the file system.
6046
- **Custom** - unix processes.
6147

62-
## Roadmap
63-
64-
This is a backlog in addition to the functions described above.
65-
66-
- [X] Syntax coloring for logging output (like `tailspin`).
67-
- [X] File system support for **MacOS** (darwin system) and the **RHEL** based systems.
68-
- [X] File system support for **BSD** based systems.
69-
- [X] File system support for **Windows**.
70-
- [ ] Code coverage by tests and passing all linters.
71-
- [ ] Interface for scrolling and the mouse support.
72-
- [ ] Windows events via PowerShell.
73-
- [ ] Support remote machines via `ssh` protocol.
74-
7548
## Install
7649

77-
Binaries for all operating systems are available on the [releases](https://github.com/Lifailon/lazyjournal/releases) page.
50+
Binaries are available for download on the [releases](https://github.com/Lifailon/lazyjournal/releases) page.
51+
52+
List of supported systems and architectures in which I was able to check the functionality:
7853

79-
Development is carried out on the Ubuntu Server 24.04.1 system and Windows 10. Also tested on the Raspberry Pi (`aarch64` platform), MacOS Sequoia 15.2 (`x64` platform), Ubuntu Server 20.04.6, OpenBSD 7.6, FreeBSD 14.2 and the WSL environment on the Oracle Linux 9.1.
54+
| OS | amd64 | arm64 | Systems |
55+
| - | - | - | - |
56+
| Linux ||| Raspberry Pi, Oracle Linux (RHEL-based in WSL), Ubuntu Server 20.04.6 and above |
57+
| Darwin || | macOS Sequoia 15.2 |
58+
| BSD-based || | OpenBSD 7.6 and FreeBSD 14.2 |
59+
| Windows || | Windows 10 and 11 |
8060

8161
### Unix-based
8262

83-
Run the command in the console to quickly install or update the stable version for Linux, MacOS or the BSD-based system:
63+
Run the command in the console to quickly install or update the stable version for Linux, macOS or the BSD-based system:
8464

8565
```shell
8666
curl -sS https://raw.githubusercontent.com/Lifailon/lazyjournal/main/install.sh | bash
@@ -164,12 +144,13 @@ bash build.sh
164144

165145
- `Tab` - switch between windows.
166146
- `Shift+Tab` - return to previous window.
167-
- `Left/Right` - switch between log lists in the selected window.
168-
- `Enter` - selection a journal from the list to display log.
169-
- `Up/Down` - move up or down through all journal lists and log output, as well as changing the filtering mode in the filter window.
170-
- `<Shift/Alt>+<Up/Down>` - quickly move up or down (every `10` or `500` lines) through all journal lists and log output.
171-
- `Ctrl+R` - refresh the current log manually and go to the bottom of the output.
172-
- `Ctrl+<D/W>` - clear text input field for filter to quickly update current log output without filtering.
147+
- `Left/Right` - switch between journal lists in the selected window.
148+
- `Enter` - selection a journal from the list to display log output.
149+
- `<Up/PgUp>/<Down/PgDown>` - move up or down through all journal lists and log output, as well as changing the filtering mode in the filter window.
150+
- `<Shift/Alt>+<Up/Down>` - quickly move up or down through all journal lists and log output every `10` or `100/500` lines.
151+
- `Ctrl+E/Home` - go to top of log.
152+
- `Ctrl+D/End` - go to the end of the log.
153+
- `Ctrl+W` - clear text input field for filter to quickly update current log output without filtering.
173154
- `Ctrl+C` - exit.
174155

175156
## Contributing

img/fuzzy.jpg

-2.32 MB
Loading

0 commit comments

Comments
 (0)