40.0.3 • Published 19 days ago

@gitbeaker/cli v40.0.3

Weekly downloads
353
License
MIT
Repository
github
Last release
19 days ago

A CLI Wrapper for the @gitbeaker/rest SDK.

Table of Contents

Usage

Install with npm install -g @gitbeaker/cli, or yarn add -g @gitbeaker/cli

gitbeaker [service name] [method name] --config_args pos_arg1 pos_argN --opts_arg1 --opts_argN

# A shorthand can also be used:
gb [service name] [method name] --config_args pos_arg1 pos_argN --opts_arg1 --opts_argN

Where:

  • service name is any of the supported API names of the @gitbeaker/rest sdk
  • method name is any of the supported commands on that API service (See source for exceptions, but generally all, show, remove, update)
  • --config_args is any of general configuration arguments such as your personal token. These are outlined in this table and can also be found by looking at the cli help menu. These arguments must also include a gb or gl prefix. ie.
# To get all the projects
gitbeaker projects all --gb-token="personaltoken"
  • pos_arg1 ... pos_argN 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. These positional arguments can also be written as flag arguments: --pos_arg1 ... --pos_argN, BUT must be written in the correct order.
  • --opts_arg1 ...--opts_argN are any of the optional arguments that you would normally supply to the function. Their names should match what the GitLab API docs request.
# To get all the projects id=2 and optional parameter "search" = "cool"
gitbeaker projects all --gb-token="personaltoken" 2 --search="cool"

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:

GITLAB_HOST=http://example.com
GITLAB_TOKEN=personaltoken
GITBEAKER_CAMELIZE=true

This could be set globally or using a .env file in the project folder.

Contributors

This started as a fork from node-gitlab-legacy but I ended up rewriting much of the code. Here are the original work's contributors.

40.0.3

19 days ago

40.0.2

1 month ago

40.0.1

1 month ago

40.0.0

1 month ago

39.34.3

2 months ago

39.34.2

3 months ago

39.34.1

3 months ago

39.34.0

3 months ago

39.33.2

3 months ago

39.33.1

3 months ago

39.33.0

3 months ago

39.32.0

3 months ago

39.31.1

3 months ago

39.31.0

3 months ago

39.30.0

3 months ago

39.29.0

4 months ago

39.28.0

4 months ago

39.27.1

4 months ago

39.27.0

4 months ago

39.26.2

5 months ago

39.26.1

5 months ago

39.26.0

5 months ago

39.25.1

5 months ago

39.12.0

8 months ago

39.24.0

6 months ago

39.19.0

7 months ago

39.11.0

9 months ago

39.23.0

6 months ago

39.18.0

7 months ago

39.5.1

10 months ago

39.5.0

10 months ago

39.10.3

9 months ago

39.10.1

9 months ago

39.10.2

9 months ago

39.10.0

9 months ago

39.22.0

6 months ago

39.17.0

7 months ago

39.21.1

6 months ago

39.21.2

6 months ago

39.21.0

6 months ago

39.7.0

10 months ago

39.16.0

7 months ago

39.20.0

7 months ago

39.6.0

10 months ago

39.15.0

8 months ago

39.9.0

9 months ago

39.14.0

8 months ago

39.8.0

10 months ago

39.13.0

8 months ago

39.25.0

5 months ago

39.4.0

10 months ago

39.3.0

10 months ago

38.11.0

11 months ago

39.2.0

10 months ago

38.12.1

11 months ago

38.12.0

11 months ago

39.1.1

10 months ago

39.1.0

11 months ago

39.0.0

11 months ago

38.4.0

12 months ago

38.0.1

1 year ago

38.0.0

1 year ago

38.8.0

12 months ago

38.5.0

12 months ago

38.1.0

1 year ago

38.1.1

12 months ago

38.9.0

11 months ago

38.6.0

12 months ago

38.2.0

12 months ago

37.0.0

1 year ago

38.3.0

12 months ago

37.1.0

1 year ago

38.10.0

11 months ago

38.7.0

12 months ago

36.0.1-next.0

1 year ago

36.0.1-next.1

1 year ago

35.8.1

1 year ago

36.0.0-rc.2

1 year ago

36.0.0-rc.0

1 year ago

35.8.0

1 year ago

35.6.1

2 years ago

35.7.0

2 years ago

35.6.0

2 years ago

35.5.0

2 years ago

35.2.0

2 years ago

35.3.0

2 years ago

35.4.0

2 years ago

34.7.0

2 years ago

35.0.0

2 years ago

35.1.0

2 years ago

34.6.0

2 years ago

34.5.0

2 years ago

34.3.0

3 years ago

34.4.1

3 years ago

34.4.0

3 years ago

34.2.0

3 years ago

34.1.0

3 years ago

34.0.1

3 years ago

34.0.0

3 years ago

33.0.1

3 years ago

32.3.0

3 years ago

33.0.0

3 years ago

32.2.0

3 years ago

32.1.2

3 years ago

32.1.1

3 years ago

32.1.0

3 years ago

31.1.0

3 years ago

32.0.0

3 years ago

31.0.0

3 years ago

30.5.0

3 years ago

30.4.0

3 years ago

30.3.0

3 years ago

29.2.3

3 years ago

29.2.4

3 years ago

29.2.1

3 years ago

29.2.2

3 years ago

30.2.0

3 years ago

29.3.0

3 years ago

30.1.0

3 years ago

30.0.0

3 years ago

29.2.0

3 years ago

29.0.0

3 years ago

28.4.0

3 years ago

28.4.1

3 years ago

29.1.0

3 years ago

28.3.0

3 years ago

28.2.0

3 years ago

28.1.0

3 years ago

28.1.1

3 years ago

28.0.4

3 years ago

28.0.3

3 years ago

28.0.2

3 years ago

28.0.1

3 years ago

28.0.0

3 years ago

27.0.1

3 years ago

27.0.0

3 years ago

26.0.1

3 years ago

26.0.0

3 years ago

25.6.0

3 years ago

25.5.0

3 years ago

25.4.0

3 years ago

25.3.0

3 years ago

25.2.0

4 years ago

25.1.0

4 years ago

24.3.0

4 years ago

25.0.0

4 years ago

24.2.0

4 years ago

24.1.0

4 years ago

24.0.3

4 years ago

24.0.2

4 years ago

24.0.1

4 years ago

24.0.0

4 years ago

23.7.0

4 years ago

23.6.0

4 years ago

23.5.0

4 years ago

23.4.2

4 years ago

23.4.1

4 years ago

23.4.0

4 years ago

23.3.0

4 years ago

23.2.0

4 years ago

23.1.0

4 years ago

23.0.0

4 years ago

22.0.1

4 years ago

22.0.0

4 years ago

21.6.0

4 years ago

21.7.0

4 years ago

21.2.0

4 years ago

21.1.0

4 years ago

21.4.0

4 years ago

21.3.0

4 years ago

21.5.0

4 years ago

21.0.1

4 years ago

21.0.0

4 years ago

20.0.0

4 years ago

19.7.1

4 years ago

19.7.0

4 years ago

19.6.0

4 years ago

19.5.0

4 years ago

19.5.1

4 years ago

19.4.0

4 years ago

19.3.1

4 years ago

19.3.0

4 years ago

19.2.0

4 years ago

19.1.0

4 years ago

19.0.0

4 years ago

18.2.0

4 years ago

18.1.0

4 years ago

18.0.0

4 years ago

17.0.3

4 years ago

17.0.2

4 years ago

16.0.0

4 years ago

17.0.1

4 years ago

17.0.0

4 years ago

15.2.0

4 years ago

15.1.0

4 years ago

15.0.0

4 years ago

15.0.3

4 years ago