# simple-gitlab-api

> A simple GitLab API library for Node.js using simple request-promise calls

Latest version **1.4.0** (published 2018-01-24) · ISC license · 0 weekly downloads

## Install

```sh
npm install simple-gitlab-api
pnpm add simple-gitlab-api
yarn add simple-gitlab-api
bun add simple-gitlab-api
```

## 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.4.0 |
| Published | 2018-01-24 |
| First published | 2017-08-27 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 3 |
| Author | Nap Ramirez |
| Maintainers | napramirez |
| Keywords | simple, node, js, gitlab, api, library |

## Links

- npm: https://www.npmjs.com/package/simple-gitlab-api
- Repository: https://github.com/napramirez/simple-gitlab-api
- Homepage: https://github.com/napramirez/simple-gitlab-api#readme
- Issues: https://github.com/napramirez/simple-gitlab-api/issues
- npm.io page: https://npm.io/package/simple-gitlab-api

## Dependencies (2)

- [request](https://npm.io/package/request.md) ^2.81.0
- [request-promise](https://npm.io/package/request-promise.md) ^4.2.1

## Alternatives

- [@mapbox/jsonlint-lines-primitives](https://npm.io/package/@mapbox/jsonlint-lines-primitives.md) — 5.3M weekly downloads
- [reftools](https://npm.io/package/reftools.md) — 3.5M weekly downloads
- [@hey-api/openapi-ts](https://npm.io/package/@hey-api/openapi-ts.md) — 3.5M weekly downloads
- [@mapbox/geojson-rewind](https://npm.io/package/@mapbox/geojson-rewind.md) — 2.4M weekly downloads
- [turbo-stream](https://npm.io/package/turbo-stream.md) — 1.7M weekly downloads

## Recent versions

- 1.4.0 (latest) — 2018-01-24
- 1.3.0 — 2017-11-06
- 1.2.0 — 2017-11-02
- 1.1.0 — 2017-10-19
- 1.0.5 — 2017-10-17
- 1.0.4 — 2017-09-18
- 1.0.3 — 2017-09-12
- 1.0.2 — 2017-09-11
- 1.0.1 — 2017-08-29
- 1.0.0 — 2017-08-27

## README

# simple-gitlab-api
[![npm version](https://badge.fury.io/js/simple-gitlab-api.svg)](https://badge.fury.io/js/simple-gitlab-api)
[![Build Status](https://travis-ci.org/napramirez/simple-gitlab-api.svg?branch=master)](https://travis-ci.org/napramirez/simple-gitlab-api)

[![NPM](https://nodei.co/npm/simple-gitlab-api.png)](https://nodei.co/npm/simple-gitlab-api/)

A simple GitLab API library for Node.js using simple request-promise calls

Install
=======

```bash
# Install from npm
npm install simple-gitlab-api
```

Usage in Node.js
================

```javascript
var gitlab = require('simple-gitlab-api');

gitlab.get('/groups').then(function(groups) {
  for (var i = 0; i < groups.length; i++)
    console.log(groups[i].name);
});
```

Environment Variables
=====================

- `GITLAB_URL` - the url to the GitLab server, _e.g._ `https://gitlab.mycompany.com`
- `GITLAB_API_PREFIX` - the API endpoint prefix including the API version, _e.g._ `/api/v4`
- `GITLAB_API_TOKEN` - the access token to the API passed into the header, _e.g._ (as used in `curl`):
```bash
curl --request GET --header 'PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK' 'https://gitlab.example.com/api/v4/projects/13083/repository/files/app%2Fmodels%2Fkey%2Erb/raw?ref=master'
```

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