# @nx-cloud/runners

> `@nx-cloud/runners` is a set of runners for Nx projects.

Latest version **1.1.0** (published 2021-12-27) · MIT license · 0 weekly downloads

## Install

```sh
npm install @nx-cloud/runners
pnpm add @nx-cloud/runners
yarn add @nx-cloud/runners
bun add @nx-cloud/runners
```

## Health

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

Positive: has types; no vulnerabilities.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.0 |
| Published | 2021-12-27 |
| First published | 2021-12-23 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 7 |
| Unpacked size | 41 KB |
| Known vulnerabilities | 0 (+24 in 2 direct dependencies) |
| Install scripts | no |
| GitHub stars | 75 |
| Maintainers | defenderbass |
| Keywords | nx, nx-cloud, runners, s3, cache |

## Links

- npm: https://www.npmjs.com/package/@nx-cloud/runners
- Repository: https://github.com/IKatsuba/nx-cloud
- Homepage: https://github.com/IKatsuba/nx-cloud/tree/main/libs/runners
- Issues: https://github.com/IKatsuba/nx-cloud/issues
- npm.io page: https://npm.io/package/@nx-cloud/runners

## Dependencies (7)

- [axios](https://npm.io/package/axios.md) ^0.24.0
- [aws-sdk](https://npm.io/package/aws-sdk.md) ^2.1046.0
- [signale](https://npm.io/package/signale.md) ^1.4.0
- [injection-js](https://npm.io/package/injection-js.md) ^2.4.0
- [firebase-admin](https://npm.io/package/firebase-admin.md) ^10.0.1
- [simple-archiver](https://npm.io/package/simple-archiver.md) ^1.0.1
- [reflect-metadata](https://npm.io/package/reflect-metadata.md) ^0.1.13

## Alternatives

- [memory-cache](https://npm.io/package/memory-cache.md) — 795.0K weekly downloads
- [@httptoolkit/proxy-agent](https://npm.io/package/@httptoolkit/proxy-agent.md) — 11.2K weekly downloads
- [express-cache-controller](https://npm.io/package/express-cache-controller.md) — 5.3K weekly downloads
- [http-cache-middleware](https://npm.io/package/http-cache-middleware.md) — 4.5K weekly downloads
- [cache2](https://npm.io/package/cache2.md) — 1.5K weekly downloads

## Recent versions

- 1.1.0 (latest) — 2021-12-27
- 1.0.2 — 2021-12-23
- 1.0.1 — 2021-12-23
- 1.0.0 — 2021-12-23

## README

# `@nx-cloud/runners`

> **Attention is required!** This project is not an official [Nx Cloud](https://nx.app) service. This is an open-source alternative.

`@nx-cloud/runners` is a set of runners for Nx projects.

Now available 1 runner for caching build artifacts with S3 `@nx-cloud/runners/s3`

## `@nx-cloud/runners/s3`

### Configuring the S3 runner

The runner is configured in `nx.json`. Available all options of default runner configuration.

```json
{
  "tasksRunnerOptions": {
    "default": {
      "runner": "@nx-cloud/runners/s3",
      "options": {
        "cacheableOperations": [
          "build",
          "lint",
          "test",
          "e2e"
        ]
      }
    }
  }
}
```

Connection is configured using the `s3` option

```json
{
  "tasksRunnerOptions": {
    "default": {
      "runner": "@nx-cloud/runners/s3",
      "options": {
        "cacheableOperations": [
          "build",
          "lint",
          "test",
          "e2e"
        ],
        "s3": {
          "endpoint": "http://192.168.1.4:9000",
          "accessKeyId": "accessKeyId",
          "secretAccessKey": "secretAccessKey",
          "bucket": "bucket"
        }
      }
    }
  }
}
```

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