refact: rename package to fmtjournal and add tools

.github/workflows/checks.yaml

@@ -4,6 +4,10 @@ on: [pull_request]
 
 jobs:
   checks:
+    permissions:
+      checks: write
+      contents: read
+      pull-requests: write
     runs-on: ubuntu-latest
     steps:
-      - uses: black-desk/checks@v1
+      - uses: black-desk/checks@master

.gitignore

@@ -1 +1 @@
-journalfmt
+/fmtjournal

README.md

@@ -44,15 +44,20 @@ Then go to check the [default format](./consts/consts.go),
 Here are something you should know:
 
 - `{{.timestamp}}`
-  
+
   Formatted `__REALTIME_TIMESTAMP` stored in `.timestamp`
 
 - `{{.extra}}`
-  
+
   Custom fields not list in `man systemd.journal-fields` is place in a
   `map[string]any` at `.extra`
 
 - `{{indent <number> string}}`
-  
+
   There is a helper function `indent` you can use it to format your string, it
   replace all `\n` in your string with `\n` and `\t` \* `<number>`
+
+## Tips
+
+Copy ./tools/journalctl to your ~/.local/bin then
+your journalctl output is format automatically.

cmd/root.go

@@ -18,14 +18,14 @@ import (
 	"github.com/adrg/xdg"
 	"github.com/spf13/cobra"
 
-	"github.com/black-desk/journalfmt/consts"
-	"github.com/black-desk/journalfmt/types"
+	"github.com/black-desk/fmtjournal/consts"
+	"github.com/black-desk/fmtjournal/types"
 )
 
 var flags types.Flags
 
 var rootCmd = &cobra.Command{
-	Use:   "journalfmt",
+	Use:   "fmtjournal",
 	Short: "A tool format journalctl json stream from stdin.",
 	RunE: func(_ *cobra.Command, args []string) (err error) {
 		return rootCmdRun(flags)

go.mod

@@ -1,4 +1,4 @@
-module github.com/black-desk/journalfmt
+module github.com/black-desk/fmtjournal
 
 go 1.20
 

main.go

@@ -1,6 +1,6 @@
 package main
 
-import "github.com/black-desk/journalfmt/cmd"
+import "github.com/black-desk/fmtjournal/cmd"
 
 func main() {
 	cmd.Execute()

tools/journalctl

@@ -0,0 +1,3 @@
+#!/bin/env sh
+
+/usr/bin/journalctl -o json --all "$@" | fmtjournal | less -r