open-index/open-npm huggingface dataset:
npm package: @financial-times/get-origami-repos
Description: Get a JSON array of all Origami GitHub repositories
Latest version: 1.0.2


# Get Origami Repos

Get a JSON array of all Origami GitHub repositories.


## Usage

### Requirements

Running Get Origami Repos requires [Node.js] 8+ and [npm] 5+. Install globally with:

```sh
npm install -g @financial-times/get-origami-repos
```

### Running

Run the command with:

```sh
GITHUB_AUTH_TOKEN=XXXXXX get-origami-repos
```

To save to a local JSON file:

```sh
GITHUB_AUTH_TOKEN=XXXXXX get-origami-repos > origami-repos.json
```


## Contact

If you have any questions or comments about this module, or need help using it, please either [raise an issue][issues], visit [#ft-origami] or email [Origami Support].


## Licence

This software is published by the Financial Times under the [MIT licence].



[#ft-origami]: https://financialtimes.slack.com/messages/ft-origami/
[issues]: https://github.com/Financial-Times/get-origami-repos/issues
[mit license]: http://opensource.org/licenses/MIT
[node.js]: https://nodejs.org/
[npm]: https://www.npmjs.com/
[origami support]: mailto:origami-support@ft.com
npm package: @financial-times/git
Description: This library assists with common git operations such as cloning a repository, adding a file, committing a file and pushing to a remote.
Latest version: 3.0.0

# git

This library assists with common git operations such as cloning a repository,
adding a file, committing a file and pushing to a remote.

This library is a thin wrapper around [dugite](https://github.com/desktop/dugite),
which provides JavaScript bindings for interacting with the git command line
interface.

## Usage

```
npm install @financial-times/git
```

```javascript
const git = require('@financial-times/git');

git.defaults({ workingDirectory: '/tmp/repository' });

await git.clone({ repository: 'git@github.com:org/repository.git' });
await git.createBranch({ name: 'new-feature-branch' });
```

See [`src/index.js`](src/index.js) for all available methods and
[`examples/`](examples/) for usage examples.
npm package: @financial-times/grafana-tools
Description: Automate your project Grafana dashboards
Latest version: 2.0.1


# Grafana Tools [![MIT licensed](https://img.shields.io/badge/license-MIT-blue.svg)][license]

Automate your project Grafana dashboards.

```sh
grafana pull <slug> <file>
grafana push <slug> <file>
```

## Table Of Contents

  * [Requirements](#requirements)
  * [Install](#install)
  * [Usage](#usage)
  * [Testing](#testing)
  * [Deployment](#deployment)
  * [License](#license)


## Requirements

Running Grafana tools requires [Node.js] 10.x and [npm].


## Install

```sh
npm install -g @financial-times/grafana-tools
```

## Usage

Pull a JSON representation of a dashboard and save it locally:

```
Usage: grafana pull <name> <file> [options]

Options:

  -h, --help             output usage information
  -V, --version          output the version number
  -a, --api-key <key>    the API key to use when accessing the Grafana API
  -H, --hostname <host>  the hostname Grafana runs on
```

Push a local JSON representation of a dashboard to the server:

```
Usage: grafana-push <name> <file> [options]

Options:

  -h, --help             output usage information
  -V, --version          output the version number
  -a, --api-key <key>    the API key to use when accessing the Grafana API
  -H, --hostname <host>  the hostname Grafana runs on
  -o, --overwrite        whether to overwrite any changes on the server
```

Note: the `--api-key` option can also be set with a `GRAFANA_API_KEY` environment variable.


## Testing

To run tests on your machine you'll need to install [Node.js] and run `make install`. Then you can run the following commands:

```sh
make test              # run all the tests
make test-unit         # run the unit tests
```

You can run the unit tests with coverage reporting, which expects 90% coverage or more:

```sh
make test-unit-coverage verify-coverage
```

The code will also need to pass linting on CI, you can run the linter locally with:

```sh
make verify
```

We run the tests and linter on CI, you can view ci. `make test` and `make lint` must pass before we merge a pull request.


## Deployment

New versions of the module are published automatically by CI when a new tag is created matching the pattern `/v.*/`.

## Migration guide

State | Major Version | Last Minor Release | Migration guide |
:---: | :---: | :---: | :---:
✨ active | 2 | N/A | [migrate to v2](MIGRATION.md#migrating-from-v1-to-v2) |
⚠ maintained | 1 | 1.0 | N/A |

## License

The Financial Times has published this software under the [MIT license][license].

[license]: http://opensource.org/licenses/MIT
[node.js]: https://nodejs.org/
[npm]: https://www.npmjs.com/
[semver]: http://semver.org/