Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tootallnate/nightscout-ps1
Renders your latest blood glucose reading from Nightscout in the command line
https://github.com/tootallnate/nightscout-ps1
Last synced: 4 days ago
JSON representation
Renders your latest blood glucose reading from Nightscout in the command line
- Host: GitHub
- URL: https://github.com/tootallnate/nightscout-ps1
- Owner: TooTallNate
- License: mit
- Created: 2018-01-10T20:49:47.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2023-10-02T18:27:38.000Z (about 1 year ago)
- Last Synced: 2024-12-10T14:04:42.440Z (16 days ago)
- Language: JavaScript
- Homepage:
- Size: 371 KB
- Stars: 21
- Watchers: 5
- Forks: 5
- Open Issues: 3
-
Metadata Files:
- Readme: Readme.md
- License: LICENSE
Awesome Lists containing this project
README
# nightscout-ps1
[](https://travis-ci.org/TooTallNate/nightscout-ps1)
Syncs the latest two entries from Nightscout to a file the can be consumed by your command line prompt (a.k.a. [`$PS1`][ps1]).
## Installation
Preferred installation is by downloading a pre-compiled binary for your platform:
* [GitHub Releases](https://github.com/TooTallNate/nightscout-ps1/releases/latest)
If there is no binary for your platform, or you would simply like to install
from source, you may install from the `npm` registry:
```bash
$ npm install -g nightscout-ps1
```
## Usage
The flags for usage of `nightscout-ps1` are listed here, however it is highly
recommended that you set up the daemon as a "service" for your operating system.
```bash
$ nightscout-ps1 -n "my-nightscout-url.com" -c ~/.nightscout-ps1.env
```
Replace `my-nightscout-url.com` with the actual URL to your own Nightscout
deployment.
| Flag | Description |
|---------------------|----------------------------------------------------------------------|
| `--cache-file`/`-c` | Path to write the latest reading file.
Must end in `.env` or `.json`, and may be specified more than once.
Defaults to `~/.nightscout-ps1.env`. |
| `--nightscout`/`-n` | URL of your Nightscout deployment. |
### Setup on macOS
```bash
cp service/io.n8.nightscout-ps1.plist ~/Library/LaunchAgents/
launchctl load ~/Library/LaunchAgents/io.n8.nightscout-ps1.plist
```
Then see [Configuring your `PS1`][config] below.
### Setup on Linux
```bash
cp service/nightscout-ps1.service /etc/systemd/system/
sudo systemd start nightscout-ps1
sudo systemd enable nightscout-ps1
```
Then see [Configuring your `PS1`][config] below.
### Setup on Windows
Check out this blog post by [Scott Hanselman](https://twitter.com/shanselman) to
setup as a Windows Service:
> [Visualizing your real-time blood sugar values AND a Git Prompt on Windows PowerShell and Linux Bash](https://www.hanselman.com/blog/VisualizingYourRealtimeBloodSugarValuesANDAGitPromptOnWindowsPowerShellAndLinuxBash.aspx)
## Configuring your `PS1`
First, [install `import`](https://import.pw/importpw/import/docs/install.md).
Second, add the following to your `.bashrc` file:
```bash
. "$(which import)"
import "tootallnate/[email protected]"
export PS1="\$(nightscout_ps1) \$ "
```
Be sure to add further customizations to your `PS1` to your liking!
## Formats
The `--cache-file`/`-c` flag determines how to format the output file based on the
file extension. These are the supported format types:
### `.env`
Formatted with `key=value` pairs that may be `source` or `eval`'d in a shell
script (i.e. your `.bashrc` file). [_Example_](examples/nightscout-ps1.env).
### `.json`
Formatted as a JSON file, which may consumed by `jq` or other related tools.
[_Example_](examples/nightscout-ps1.json).
[config]: #configuring-your-ps1
[ps1]: https://en.wikipedia.org/wiki/Command-line_interface#Command_prompt