# nixstats

> CLI and JavaScript Wrapper for NIXStats

Latest version **1.0.0** (published 2016-06-28) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install nixstats
pnpm add nixstats
yarn add nixstats
bun add nixstats
```

Provides the command `nixstats`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2016-06-28 |
| First published | 2016-06-16 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 5 |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 4 |
| Author | Guilherme Oenning |
| Maintainers | goenning |

## Links

- npm: https://www.npmjs.com/package/nixstats
- Repository: https://github.com/goenning/nixstats-js
- Homepage: https://github.com/goenning/nixstats-js#readme
- Issues: http://github.com/goenning/nixstats-js/issues
- npm.io page: https://npm.io/package/nixstats

## Dependencies (5)

- [meow](https://npm.io/package/meow.md) ^3.7.0
- [clear](https://npm.io/package/clear.md) 0.0.1
- [cliff](https://npm.io/package/cliff.md) ^0.1.10
- [debug](https://npm.io/package/debug.md) ^2.2.0
- [request](https://npm.io/package/request.md) ^2.72.0

## Recent versions

- 1.0.0 (latest) — 2016-06-28
- 0.0.4 — 2016-06-20
- 0.0.3 — 2016-06-17
- 0.0.2 — 2016-06-17
- 0.0.1 — 2016-06-16

## README

# NIXStats.js is CLI and JavaScript Wrapper for [NIXStats](https://nixstats.com)

## Using as CLI

### Install

Install it with `npm install -g nixstats`.

### Usage

Go to [NIXStats](https://nixstats.com) and generate your own API token.

Run `nixstats config <your_token_goes_here>`

Run `nixstats now` to see current servers situation.

![](nixstats.png)

### Help

Run `nixstats --help` for full CLI options.

## Using as a JavaScript Wrapper for NIXStats API

### Install

Install it with `npm install nixstats -save`.

### Usage

```javascript
var ns = require('nixstats');
var nsClient = new ns.NIXStatsClient('<<your_token_goes_here>');
nsClient.server.list().then((result) => {
  for(var server of result.servers) {
    //...
  }
});
```

### About

1. For full list of `NIXStatsClient` functions see [index.js](lib/index.js);
2. All functions are returned as Promises;
3. The result of each Promise is exactly as shown in the [official documentation](https://nixstats.com/api/documentation.html);

## Looking forward

- [CLI] output more useful information;
- [CLI] more operations, history, details, etc;
- [Wrapper] enable the user to choose between Promises or Callback;

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