🤖 [GitLab](https://gitlab.com/gitlab-org/gitlab/) API NodeJS library with full support of all the [Gitlab API](https://gitlab.com/gitlab-org/gitlab/tree/master/doc/api) services.
@@ -40,23 +70,42 @@
```bash
# Install from npm
-npm install gitlab
+npm install @gitbeaker/node # NodeJS default, index.es.js for esm
+
+npm install @gitbeaker/browser # UMD default
+
+npm install @gitbeaker/cli # CLI
+
```
## Getting Started
-Instantiate the library using a basic token created in your [Gitlab Profile](https://docs.gitlab.com/ce/user/profile/personal_access_tokens.html)
+**NodeJS**
```javascript
// ES6 (>=node 10.16.0 LTS)
-import { Gitlab } from 'gitlab'; // All Resources
-import { Projects } from 'gitlab'; // Just the Project Resource
+import { Gitlab } from '@gitbeaker/node'; // All Resources
+import { Projects } from '@gitbeaker/node'; // Just the Project Resource
//...etc
// ES5, assuming native or polyfilled Promise is available
-const { Gitlab } = require('gitlab');
+const { Gitlab } = require('@gitbeaker/node');
```
+**Browser**
+
+```javascript
+// ES6 (>=node 10.16.0 LTS)
+import { Gitlab } from '@gitbeaker/browser'; // All Resources
+import { Projects } from '@gitbeaker/browser'; // Just the Project Resource
+//...etc
+
+// ES5, assuming native or polyfilled Promise is available
+const { Gitlab } = require('@gitbeaker/browser');
+```
+
+Instantiate the library using a basic token created in your [Gitlab Profile](https://docs.gitlab.com/ce/user/profile/personal_access_tokens.html)
+
```javascript
const api = new Gitlab({
token: 'personaltoken',
@@ -65,46 +114,47 @@ const api = new Gitlab({
Available instantiating options:
-| Name | Optional | Default | Description |
-| -------------------- | -------- | ----------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------ |
-| `host` | Yes | `https://gitlab.com` | Gitlab Instance Host URL |
-| `token` | No\* | N/A | Personal Token. Required (one of the three tokens are required) |
-| `oauthToken` | No\* | N/A | OAuth Token. Required (one of the three tokens are required) |
-| `jobToken` | No\* | N/A | CI Job Token. Required (one of the three tokens are required) |
-| `rejectUnauthorized` | Yes | `true` | Http Certificate setting, Only applies to HTTPS hosts urls |
-| `sudo` | Yes | `false` | [Sudo](https://docs.gitlab.com/ee/api/#sudo) query parameter |
-| `version` | Yes | `4` | API Version ID |
-| `camelize` | Yes | `false` | Camelizes all response body keys |
-| `requester` | Yes | [KyRequester.ts](./src/infrastructure/KyRequester.ts) | Request Library Wrapper. Currently wraps Ky. |
-| `requestTimeout` | Yes | `300000` | Request Library Timeout in ms |
-| `profileToken` | Yes | N/A | [Requests Profiles Token](https://docs.gitlab.com/ee/administration/monitoring/performance/request_profiling.html) |
-| `profileMode` | Yes | `execution` | [Requests Profiles Token](https://docs.gitlab.com/ee/administration/monitoring/performance/request_profiling.html) |
+| Name | Optional | Default | Description |
+| -------------------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------ |
+| `host` | Yes | `https://gitlab.com` | Gitlab Instance Host URL |
+| `token` | No\* | N/A | Personal Token. Required (one of the three tokens are required) |
+| `oauthToken` | No\* | N/A | OAuth Token. Required (one of the three tokens are required) |
+| `jobToken` | No\* | N/A | CI Job Token. Required (one of the three tokens are required) |
+| `rejectUnauthorized` | Yes | `true` | Http Certificate setting, Only applies to HTTPS hosts urls |
+| `sudo` | Yes | `false` | [Sudo](https://docs.gitlab.com/ee/api/#sudo) query parameter |
+| `version` | Yes | `4` | API Version ID |
+| `camelize` | Yes | `false` | Camelizes all response body keys |
+| `requester` | Yes\* | For @gitbeaker/node and @gitbeaker/cli, it uses a Got based requester, for @gitbeaker/browser, it uses a ky based requester. The @gitbeaker/core package **does not** have a default and thus must be set explicitly | Request Library Wrapper |
+| `requestTimeout` | Yes | `300000` | Request Library Timeout in ms |
+| `profileToken` | Yes | N/A | [Requests Profiles Token](https://docs.gitlab.com/ee/administration/monitoring/performance/request_profiling.html) |
+| `profileMode` | Yes | `execution` | [Requests Profiles Token](https://docs.gitlab.com/ee/administration/monitoring/performance/request_profiling.html) |
### CLI Support
The CLI export functions in a similar manner, following the pattern:
```bash
-gitlab [service name] [method name] --arg1 --arg2 --arg3
+gitbeaker [service name] [method name] --arg1 --arg2 --arg3
```
Where `service name` is any of the supported API names, `method name` is any of the supported commands on that API service (See source for exceptions, but generally all, show, remove, update) and `--arg1...--arg3` are any of the arguments you would normally supply to the function. The names of the args should match the names in the method headers **EXCEPT** all the optional arguments whose names should match what the GitLab API docs request.
-There is one small exception with the instantiating arguments, however, which must be supplied using a `gl` prefix. ie.
+There is one small exception with the instantiating arguments, however, which must be supplied using a `gb` or `gl` prefix. ie.
```bash
# To get all the projects
-gitlab projects all --gl-token="personaltoken"
+gitbeaker projects all --gb-token="personaltoken"
# To get a project with id = 2
-gitlab projects show --gl-token="personaltoken" --projectId=2
+gitbeaker projects show --gl-token="personaltoken" --projectId=2
```
-To reduce the annoyance of having to pass those configuration properties each time, it is also possible to pass the token and host information through environment variables in the form of `GITLAB_[option name]` ie:
+To reduce the annoyance of having to pass those configuration properties each time, it is also possible to pass the token and host information through environment variables in the form of `GITLAB_[option name]` or `GITBEAKER_[option name]` ie:
```bash
GITLAB_HOST=http://example.com
GITLAB_TOKEN=personaltoken
+GITBEAKER_CAMELIZE=true
```
This could be set globally or using a [.env](https://github.com/motdotla/dotenv#readme) file in the project folder.
@@ -114,7 +164,7 @@ This could be set globally or using a [.env](https://github.com/motdotla/dotenv#
The library is exported as `gitlab` and can be used by simply adding this script to your html file:
```html
-
+
+
+
+
+ 
+
+
+ 
+
+
+ 
+
+ 
+
+
+ 
+
+ 
+
+ 
+
+