From 2ed2195fed0b1ae906f22e10c2de5ad267615024 Mon Sep 17 00:00:00 2001 From: Colin Date: Tue, 18 Jun 2024 19:00:40 -0400 Subject: [PATCH] debugreport functional --- README.md | 21 ++++++++++++++++++++- 1 file changed, 20 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 40cb0cc..9eaa42a 100644 --- a/README.md +++ b/README.md @@ -10,6 +10,16 @@ To use DebugReport, ensure you have the `asciinema` tool installed on your syste You can install `asciinema` by following the instructions on their [official website](https://asciinema.org/docs/installation). +## Installation + +To install the binary locally, you can use the provided installation script. Run the following command in your terminal: + +```sh +curl -sSL https://git.nixc.us/colin/debugreport/raw/branch/master/install.sh | bash +``` + +This will download and install the debugreport and decodereport binary to your local machine. + ## Usage You can use DebugReport to record your terminal sessions, upload the recordings to Hastebin, and send notifications to Pushover. @@ -19,7 +29,7 @@ You can use DebugReport to record your terminal sessions, upload the recordings Run the `debugreport` command: ```sh -./debugreport +debugreport ``` You will see a message indicating that the recording has started. To stop the recording, press `Ctrl+D` or type `exit`. @@ -35,6 +45,15 @@ Is this a priority notification? (yes/no): - If you answer `yes`, the notification will be sent as a high-priority (emergency) notification with a retry interval of 60 seconds and an expire time of 1800 seconds (30 minutes). - If you answer `no`, the notification will be sent as a low-priority notification. + +### Play a Recording + +Run the `decodereport` command: + +```sh +decodereport https://haste.nixc.us/token +``` + ## External Services DebugReport interacts with the following external services: