https://github.com/hscells/headway

monitor the progress of stuff remotely
https://github.com/hscells/headway

Last synced: 7 days ago
JSON representation

monitor the progress of stuff remotely

• Host: GitHub
• URL: https://github.com/hscells/headway
• Owner: hscells
• Created: 2019-11-20T06:16:09.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2020-04-24T10:20:38.000Z (over 4 years ago)
• Last Synced: 2024-06-21T20:08:43.400Z (5 months ago)
• Language: Go
• Size: 34.2 KB
• Stars: 1
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# headway

_Monitor the progress of stuff, and alert you if it goes wrong._

To install:

```bash

go get -u github.com/hscells/headway/cmd/hw

```

To create/update a progress bar, send a `PUT` request to the server:

```

curl -X PUT "localhost:7777/?secret=ABC-XYZ-123&name=example&current=10&total=100&comment=test"

```

Only the `comment` parameter is optional. Both the `current` and `total` must be send each bar update. The `name` parameter is also always required.

The `secret` parameter will be made available once you log in through Slack.

An additional, optional, `message` parameter can be used to send a direct message to yourself on Slack, as an alert. For example:

```

curl -X PUT "localhost:7777/?secret=ABC-XYZ-123&message=task%20crashed%20on%20line%2042"

```

## todo

 - documentation for slack setup