# circleci-env

> Configure CircleCI with an environment variable

Latest version **1.0.0** (published 2016-10-11) · MIT license · 0 weekly downloads

## Install

```sh
npm install circleci-env
pnpm add circleci-env
yarn add circleci-env
bun add circleci-env
```

## 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-10-11 |
| First published | 2016-10-11 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| Author | Ben Drucker |
| Maintainers | bendrucker |
| Keywords | circle, ci, circleci, env, environment, variable |

## Links

- npm: https://www.npmjs.com/package/circleci-env
- Repository: https://github.com/bendrucker/circleci-env
- Homepage: https://github.com/bendrucker/circleci-env#readme
- Issues: https://github.com/bendrucker/circleci-env/issues
- npm.io page: https://npm.io/package/circleci-env

## Dependencies (2)

- [got](https://npm.io/package/got.md) ~6.5.0
- [snakecase-keys](https://npm.io/package/snakecase-keys.md) ~1.0.0

## Alternatives

- [replicas-cli](https://npm.io/package/replicas-cli.md) — 3.0K weekly downloads
- [env-contract](https://npm.io/package/env-contract.md) — 133 weekly downloads
- [@openveo/api](https://npm.io/package/@openveo/api.md) — 61 weekly downloads
- [@ryniaubenpm2/cumque-error-reiciendis](https://npm.io/package/@ryniaubenpm2/cumque-error-reiciendis.md) — 54 weekly downloads
- [ts-global-type-extra](https://npm.io/package/ts-global-type-extra.md) — 11 weekly downloads

## Recent versions

- 1.0.0 (latest) — 2016-10-11

## README

# circleci-env [![Build Status](https://travis-ci.org/bendrucker/circleci-env.svg?branch=master)](https://travis-ci.org/bendrucker/circleci-env) [![Greenkeeper badge](https://badges.greenkeeper.io/bendrucker/circleci-env.svg)](https://greenkeeper.io/)

> Configure CircleCI with an environment variable


## Install

```
$ npm install --save circleci-env
```


## Usage

```js
var env = require('circleci-env')

env.set({
  username: 'bendrucker',
  project: 'circleci-aws',
  circle_token: token,
  name: 'FOO',
  value: 'BAR'
})
.then(console.log)

// #=> {name: 'FOO', value: 'xxxxR'}
```

## API

#### `env.get(data)` -> `promise`
#### `env.set(data)` -> `promise`
#### `env.remove(data)` -> `promise`

Gets, sets, or removes a new environment variable using the provided data.


##### data

*Required*  
Type: `object`

An object that always must contain `username`, `project`, `circle_token`, and `name` (the key name), plus `value` when calling `set`.

## License

MIT © [Ben Drucker](http://bendrucker.me)

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