# curtain-twitcher

> NodeJs tool to parse a configuration file with definitions of alerts based on data available in Graphite

Latest version **0.2.6** (published 2025-06-09) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install curtain-twitcher
pnpm add curtain-twitcher
yarn add curtain-twitcher
bun add curtain-twitcher
```

Provides the command `curtain-twitcher`.

## Health

**Score 25/100 (F)** — status: maintenance-mode.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: stale; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.2.6 |
| Published | 2025-06-09 |
| First published | 2016-05-10 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 5 |
| Unpacked size | 148.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Oleksandr Stasyk |
| Maintainers | bapti, findmypast-tech |
| Keywords | alerting, graphite |

## Links

- npm: https://www.npmjs.com/package/curtain-twitcher
- Repository: https://github.com/findmypast/curtain-twitcher
- Homepage: https://github.com/findmypast/curtain-twitcher#readme
- Issues: https://github.com/findmypast/curtain-twitcher/issues
- npm.io page: https://npm.io/package/curtain-twitcher

## Dependencies (5)

- [async](https://npm.io/package/async.md) ^2.0.0-rc.5
- [consul](https://npm.io/package/consul.md) ^0.25.0
- [pathos](https://npm.io/package/pathos.md) ^2.0.0
- [js-yaml](https://npm.io/package/js-yaml.md) ^3.6.0
- [commander](https://npm.io/package/commander.md) ^2.9.0

## Alternatives

- [update-check](https://npm.io/package/update-check.md) — 4.0M weekly downloads
- [react-native-onesignal](https://npm.io/package/react-native-onesignal.md) — 134.5K weekly downloads
- [react-redux-toastr](https://npm.io/package/react-redux-toastr.md) — 33.7K weekly downloads
- [@nocobase/plugin-notification-manager](https://npm.io/package/@nocobase/plugin-notification-manager.md) — 2.0K weekly downloads
- [react-simple-toasts](https://npm.io/package/react-simple-toasts.md) — 1.9K weekly downloads

## Recent versions

- 0.2.6 (latest) — 2025-06-09
- 0.2.4 — 2022-01-10
- 0.2.3 — 2016-06-29
- 0.2.2 — 2016-05-27
- 0.2.1 — 2016-05-27
- 0.2.0 — 2016-05-27
- 0.1.1 — 2016-05-11
- 0.1.0 — 2016-05-10

## README

# curtain-twitcher
NodeJs tool to send structured data to consul's KV store

## Installation

`npm i curtain-twitcher -g`

## Usage

Usage: `curtain-twitcher [options] <host> <path> <file>`

`<host>` is the address of the consul host

`<path>` is the root path for the consul key/value store. The path is used as a prefix to the key/value pair details held in the configuration `<file>`

`<file>` is the file path to the key/value pair configuration file. This a YML structured file that should mirror the structure required in the consul key/value store.

Options:

`-h, --help`         output usage information

`-V, --version`      output the version number

`-p, --port <port> ` Port to query the consul host on (defaults to 8500)

**Example**
```
curtain-twitcher consul.my.org my_app/environments envs.yml
```

with the `envs.yml` containing the following:

```
production:
  url: prod.my_app.org
  servers:
    server1: prod01.my_app.org
    server2: prod02.my_app.org
    server3: prod03.my_app.org
acceptance:
  url: int.my_app.org
  servers:
    server1: int01.my_app.org
    server2: int02.my_app.org
```
will produce the following key value pairs in consul:

```
my_app/environments/production/url prod.my_app.org
my_app/environments/production/servers/servers1 prod01.my_app.org
my_app/environments/production/servers/servers2 prod02.my_app.org
my_app/environments/production/servers/servers3 prod03.my_app.org
my_app/environments/integration/url int.my_app.org
my_app/environments/integration/servers/servers1 int01.my_app.org
my_app/environments/integration/servers/servers2 int02.my_app.org
```

---
_Source: https://npm.io/package/curtain-twitcher · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
