Skip to content

Commit eeb17f7

Browse files
committed
updated info for install
1 parent d2a34dd commit eeb17f7

File tree

1 file changed

+68
-33
lines changed

1 file changed

+68
-33
lines changed

README.md

Lines changed: 68 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -6,16 +6,31 @@
66
<a href="https://pkg.go.dev/github.com/Lifailon/lazyjournal"><img src="https://pkg.go.dev/badge/github.com/Lifailon/lazyjournal.svg" alt="Go Reference"></a>
77
<a href="https://goreportcard.com/report/github.com/Lifailon/lazyjournal"><img src="https://goreportcard.com/badge/github.com/Lifailon/lazyjournal" alt="Go Report"></a>
88
<a href="https://github.com/Lifailon/lazyjournal/actions/workflows/build.yml"><img title="Actions Build"src="https://img.shields.io/github/actions/workflow/status/Lifailon/lazyjournal/build.yml?logo=GitHub-Actions"></a>
9-
<a href="https://github.com/Lifailon/lazyjournal"><img title="Go Version"src="https://img.shields.io/github/go-mod/go-version/Lifailon/lazyjournal?logo=go"></a>
9+
<a href="https://aur.archlinux.org/packages/lazyjournal"><img title="Arch Linux"src="https://img.shields.io/aur/version/lazyjournal?logo=arch-linux"></a>
1010
<a href="https://github.com/Lifailon/Kinozal-Bot/blob/rsa/LICENSE"><img title="License"src="https://img.shields.io/github/license/Lifailon/Kinozal-Bot?logo=readme&color=white"></a>
1111
</p>
1212

13-
Terminal user interface for `journalctl`, file system logs, as well *Docker* and *Podman* containers for quick viewing and filtering with fuzzy find, regex support (like `fzf` and `grep`) and coloring the output, written in Go with the [awesome-gocui](https://github.com/awesome-gocui/gocui) (fork [gocui](https://github.com/jroimartin/gocui)) library.
13+
Terminal user interface for `journalctl`, file system logs, as well **Docker** and **Podman** containers for quick viewing and filtering with fuzzy find, regex support (like `fzf` and `grep`) and coloring the output, written in Go with the [awesome-gocui](https://github.com/awesome-gocui/gocui) (fork [gocui](https://github.com/jroimartin/gocui)) library.
1414

1515
This tool is inspired by and with love for [LazyDocker](https://github.com/jesseduffield/lazydocker) and [LazyGit](https://github.com/jesseduffield/lazygit), as well as is listed as [Awesome-TUIs](https://github.com/rothgar/awesome-tuis), check out the other useful projects in the repository page.
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+
1934
## Functional
2035

2136
- Simple installation, to run it, just download a single executable file without dependencies.
@@ -24,8 +39,8 @@ This tool is inspired by and with love for [LazyDocker](https://github.com/jesse
2439
- List of all system boots for kernel log output.
2540
- File system logs (example, for Apache or Nginx), as well as `syslog` or `messages`, `dmesg` (kernel), etc.
2641
- List of all log files of descriptors used by processes, as well as all log files in the home directories of users.
27-
- Reading archived logs (`gz` format).
28-
- *Podman* pods, *Docker* containers and *Swarm* services logs for all systems.
42+
- Reading archived logs (`gz`, `xz` or `bz2` format) and packet capture files (`pcap` format).
43+
- Docker containers, Podman pods and Swarm services logs.
2944
- Displays the currently selected log and filters output in real-time.
3045

3146
Supports 3 filtering modes:
@@ -38,88 +53,108 @@ Supported coloring groups for output:
3853

3954
- **Green** - keywords indicating success.
4055
- **Red** - keywords indicating an error.
41-
- **Blue** - statuses and action messages (debug, warning, etc and install, update, etc).
56+
- **Blue** - statuses, (info, debug, etc), actions (install, update, etc) and HTTP methods (GET, POST, etc).
4257
- **Light Blue** - numbers (date, time, bytes, ip and mac-addresses).
43-
- **Yellow** - known names (host name and system users).
58+
- **Yellow** - known names (host name and system users) and warnings.
4459
- **Purple** - url and full paths in the file system.
4560
- **Custom** - unix processes.
4661

4762
## Roadmap
4863

49-
This is an up-to-date roadmap in addition to the functionality described above.
64+
This is a backlog in addition to the functions described above.
5065

51-
- [X] File system support for `MacOS` (darwin system) and the `RHEL` based systems.
5266
- [X] Syntax coloring for logging output (like `tailspin`).
53-
- [ ] Windows file system support (log files from `Program Files` and others directories).
54-
- [ ] Windows events via `PowerShell`.
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.
5571
- [ ] Interface for scrolling and the mouse support.
72+
- [ ] Windows events via PowerShell.
5673
- [ ] Support remote machines via `ssh` protocol.
5774

5875
## Install
5976

60-
### Releases
77+
Binaries for all operating systems are available on the [releases](https://github.com/Lifailon/lazyjournal/releases) page.
6178

62-
Binaries for the Linux operating system are available on the [releases](https://github.com/Lifailon/lazyjournal/releases) page.
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.
6380

64-
Development is carried out on the Ubuntu Server system, and is also tested on the Raspberry Pi (`aarch64` platform), MacOS (`x64` platform) and the WSL environment on the Oracle Linux system.
81+
### Unix-based
6582

66-
Run the command in the console to quickly install or update the stable version on Linux or MacOS:
83+
Run the command in the console to quickly install or update the stable version for Linux, MacOS or the BSD-based system:
6784

6885
```shell
69-
curl https://raw.githubusercontent.com/Lifailon/lazyjournal/main/install.sh | bash
86+
curl -sS https://raw.githubusercontent.com/Lifailon/lazyjournal/main/install.sh | bash
7087
```
7188

7289
This command will run a script that will download the latest executable from the GitHub repository into your current user's home directory along with other executables (or create a directory) and grant execution permission.
7390

74-
### Latest
91+
### Arch Linux
7592

76-
You can also use Go for install the dev version. To do this, the Go interpreter must be installed on the system, for example, in Ubuntu you can use the SnapCraft package manager:
93+
If you an Arch Linux user you can also install from the [AUR](https://aur.archlinux.org/packages/lazyjournal):
7794

7895
```shell
79-
sudo snap install go --classic
80-
grep -F 'export PATH=$PATH:$HOME/go/bin' $HOME/.bashrc || echo 'export PATH=$PATH:$HOME/go/bin' >> $HOME/.bashrc && source $HOME/.bashrc
96+
paru -S lazyjournal
97+
```
8198

82-
go install github.com/Lifailon/lazyjournal@latest
99+
Thank you [Matteo Giordano](https://github.com/malteo) for upload and update the package in AUR.
100+
101+
### Windows
102+
103+
Use the following command to quickly install in your PowerShell console:
104+
105+
```PowerShell
106+
Invoke-RestMethod https://raw.githubusercontent.com/Lifailon/lazyjournal/main/install.ps1 | Invoke-Expression
83107
```
84108

85-
### Arch Linux
109+
Supports reading containers logs as well as searching for logs in the following directories:
86110

87-
If you're an Arch Linux user you can also install from the [AUR](https://aur.archlinux.org/packages/lazyjournal) with your favorite [AUR helper](https://wiki.archlinux.org/title/AUR_helpers), e.g.:
111+
- `Program Files`
112+
- `Program Files (x86)`
113+
- `AppData\Local` for current user
114+
- `AppData\Roamin` for current user
115+
116+
To read logs, automatic detection of the following encodings is supported:
117+
118+
- `UTF-8`
119+
- `UTF-16 with BOM`
120+
- `UTF-16 without BOM`
121+
- `Windows-1251` by default
122+
123+
### Go Package
124+
125+
You can also use Go for install the dev version ([Go](https://go.dev/doc/install) must be installed in the system):
88126

89127
```shell
90-
paru -S lazyjournal
128+
go install github.com/Lifailon/lazyjournal@latest
91129
```
92130

93-
Thank you [Matteo Giordano](https://github.com/malteo) for upload and update the package in AUR.
94-
95131
### Others
96132

97-
If you use other packag manager and want this package to be present there as well, open an issue or load it yourself and make `Pull requests`.
133+
If you use other packag manager and want this package to be present there as well, open an issue or load it yourself and make [Pull requests](https://github.com/Lifailon/lazyjournal/pulls).
98134

99135
## Usage
100136

101-
You can launch the interface anywhere (no parameters are used):
137+
You can run the interface from anywhere:
102138

103139
```shell
104-
lazyjournal
140+
lazyjournal # Run interface
141+
lazyjournal --help, -h # Show help
142+
lazyjournal --version, -v # Show version
105143
```
106144

107145
Access to all system logs and containers may require elevated privileges for the current user.
108146

109-
Windows is not currently supported, but the project will work to access Docker and Podman containers logs.
110-
111147
## Build
112148

113-
Clone the repository, install dependencies from `go.mod` and run the project:
149+
Clone the repository and run the project:
114150

115151
```shell
116152
git clone https://github.com/Lifailon/lazyjournal
117153
cd lazyjournal
118-
go mod tidy
119154
go run main.go
120155
```
121156

122-
Check the code for linters using [golangci-lint](https://github.com/golangci/golangci-lint) and build executables for different platforms and all systems:
157+
Check the source code on the linters using [golangci-lint](https://github.com/golangci/golangci-lint) and build binaries for different platforms and systems:
123158

124159
```shell
125160
bash build.sh

0 commit comments

Comments
 (0)