colin
/
debugreport
1
1
Fork 0
Code Pull Requests Activity

debugreport functional

This commit is contained in:
Colin 2024-06-18 19:00:40 -04:00
parent 986f7ed645
commit 2ed2195fed
1 changed files with 20 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
README.md
View File

@ -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). 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 ## Usage
You can use DebugReport to record your terminal sessions, upload the recordings to Hastebin, and send notifications to Pushover. 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: Run the `debugreport` command:
```sh ```sh
./debugreport debugreport
``` ```
You will see a message indicating that the recording has started. To stop the recording, press `Ctrl+D` or type `exit`. 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 `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. - 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 ## External Services
DebugReport interacts with the following external services: DebugReport interacts with the following external services: