|
|
@@ -1,3 +1,20 @@
|
|
|
# canary-log-viewer
|
|
|
|
|
|
Structured log viewer for canary logs.
|
|
|
+
|
|
|
+## Install
|
|
|
+1. Download and install nodejs from https://nodejs.org.
|
|
|
+2. `npm install -g --registry https://npm.bodicsek.host @os-tools/canary-log-viewer`
|
|
|
+
|
|
|
+## Usage
|
|
|
+```
|
|
|
+$ canary-log-viewer --help
|
|
|
+
|
|
|
+Usage:
|
|
|
+ canary-log-viewer logfile
|
|
|
+
|
|
|
+Options:
|
|
|
+ --help Show help [boolean]
|
|
|
+ --version Show version number [boolean]
|
|
|
+ --files Extract and save the embedded files from the log file [boolean]
|
|
|
+```
|
