Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/noahgorstein/dog-watcher
a TUI to manage processes in Stardog
https://github.com/noahgorstein/dog-watcher
Last synced: 23 days ago
JSON representation
a TUI to manage processes in Stardog
- Host: GitHub
- URL: https://github.com/noahgorstein/dog-watcher
- Owner: noahgorstein
- License: mit
- Created: 2022-08-21T16:48:56.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2023-04-23T03:38:29.000Z (over 1 year ago)
- Last Synced: 2024-06-20T22:35:17.152Z (5 months ago)
- Language: Go
- Size: 79.1 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Dog Watcher
A TUI to manage processes in Stardog.
`dog-watcher` currently supports:
- viewing processes in Stardog
- killing processes in Stardog
## Installation
### homebrew
```bash
brew install noahgorstein/tap/dog-watcher
```
### Github releases
Download the relevant asset for your operating system from the latest Github release. Unpack it, then move the binary to somewhere accessible in your `PATH`, e.g. `mv ./dog-watcher /usr/local/bin`.
### Build from source
Clone this repo, build from source with `cd dog-watcher && go build`, then move the binary to somewhere accessible in your `PATH`, e.g. `mv ./dog-watcher /usr/local/bin`.
## Usage
Run the app by running `dog-watcher` in a terminal. See `dog-watcher --help` and [configuration](#configuration) section below for details.
## Controls
| Key | Description |
| ---- | ---------- |
| `up`/`down` | move table cursor |
| `left`/`right` | page table |
| `/` | filter table |
| `esc` | clear filter |
| `ctrl+x` | kill highlighted process |
| `d`/`i` | increase/decrease refresh rate |
| `ctrl+c` | exit |
## Configuration
`dog-watcher` can be configured in a yaml file at `$HOME/.dog-watcher.yaml`.
Example yaml file:
```yaml
# .dog-watcher.yaml
username: "admin"
password: "admin"
server: "http://localhost:5820"
```
Alternatively, `dog-watcher` can be configured via environment variables, or via command line args visible by running `dog-watcher --help`.
> Command line args take precedence over both the configuation file and environment variables. Environment variables take precedence over the configuration file.
`dog-watcher` will attempt to authenticate using the default superuser `admin` with password `admin` on `http://localhost:5820` if no credentials are provided.
### Environment Variables
| Environment Variable | Description |
|---|---|
| `DOG_WATCHER_USERNAME` | username |
| `DOG_WATCHER_PASSWORD` | password |
| `DOG_WATCHER_SERVER` | Stardog server to connect to |
## Built With
- [bubbletea](https://github.com/charmbracelet/bubbletea)
- [bubbles](https://github.com/charmbracelet/bubbles)
- [bubble-table](https://github.com/Evertras/bubble-table)
- [lipgloss](https://github.com/charmbracelet/lipgloss)
- [go-stardog](https://github.com/noahgorstein/go-stardog)