Rename /usr/bin/gitlab to /usr/bin/ruby-gitlab (Closes: #910228)
Sébastien Delafond
4 years ago
0 | |
.TH GITLAB 1 "2017-09-22" "0.1" ""
|
1 | |
.SH NAME
|
2 | |
gitlab \- command line interface to gitlab
|
3 | |
.SH SYNOPSIS
|
4 | |
.br
|
5 | |
.B gitlab
|
6 | |
.I command
|
7 | |
.br
|
8 | |
.SH DESCRIPTION
|
9 | |
.B gitlab
|
10 | |
is a command line interface to gitlab based on the gem gitlab.
|
11 | |
It requires to set a few environment variables (see configuration).
|
12 | |
.PP
|
13 | |
For a complete list of supported CLI commands, see:
|
14 | |
.P
|
15 | |
<\fI\%http://www.rubydoc.info/gems/gitlab/Gitlab/Client\fP>
|
16 | |
.P
|
17 | |
Any of those methods can be called as a command by passing the parameters
|
18 | |
of the commands as parameters of
|
19 | |
.B gitlab.
|
20 | |
.SH CONFIGURATION
|
21 | |
.TP
|
22 | |
A few environment variables needs to be set:
|
23 | |
.sp
|
24 | |
export GITLAB_API_ENDPOINT=https://gitlab.yourcompany.com/api/v4
|
25 | |
.sp
|
26 | |
export GITLAB_API_PRIVATE_TOKEN=<your private token from /profile/account>
|
27 | |
.TP
|
28 | |
The variable GITLAB_API_HTTPARTY_OPTIONS is optional. It can be used to set any HTTParty option you may need using YAML hash syntax. For example SSL verification can be disabled with:
|
29 | |
.sp
|
30 | |
export GITLAB_API_HTTPARTY_OPTIONS="{verify: false}"
|
31 | |
.
|
32 | |
.SH EXAMPLES
|
33 | |
.TP
|
34 | |
To list users:
|
35 | |
.B gitlab users
|
36 | |
.TP
|
37 | |
To get current user:
|
38 | |
.B gitlab user
|
39 | |
.TP
|
40 | |
The result can be filtered:
|
41 | |
.B gitlab user \-\-only=id,username
|
42 | |
|
43 | |
.B gitlab user \-\-except=email,bio
|
44 | |
.SH SEE ALSO
|
45 | |
.IP \(bu 2
|
46 | |
gem documentation <http://www.rubydoc.info/gems/gitlab/Gitlab/Client>
|
47 | |
.IP \(bu 2
|
48 | |
/usr/share/doc/ruby\-gitlab/README.md.gz
|
49 | |
.SH AUTHOR
|
50 | |
Sophie Brun <sophie@freexian.com>
|
|
0 |
.TH RUBY-GITLAB 1 "2017-09-22" "0.1" ""
|
|
1 |
.SH NAME
|
|
2 |
ruby-gitlab \- command line interface to gitlab
|
|
3 |
.SH SYNOPSIS
|
|
4 |
.br
|
|
5 |
.B ruby-gitlab
|
|
6 |
.I command
|
|
7 |
.br
|
|
8 |
.SH DESCRIPTION
|
|
9 |
.B ruby-gitlab
|
|
10 |
is a command line interface to gitlab based on the gem gitlab.
|
|
11 |
It requires to set a few environment variables (see configuration).
|
|
12 |
.PP
|
|
13 |
For a complete list of supported CLI commands, see:
|
|
14 |
.P
|
|
15 |
<\fI\%http://www.rubydoc.info/gems/gitlab/Gitlab/Client\fP>
|
|
16 |
.P
|
|
17 |
Any of those methods can be called as a command by passing the parameters
|
|
18 |
of the commands as parameters of
|
|
19 |
.B ruby-gitlab.
|
|
20 |
.SH CONFIGURATION
|
|
21 |
.TP
|
|
22 |
A few environment variables needs to be set:
|
|
23 |
.sp
|
|
24 |
export GITLAB_API_ENDPOINT=https://gitlab.yourcompany.com/api/v4
|
|
25 |
.sp
|
|
26 |
export GITLAB_API_PRIVATE_TOKEN=<your private token from /profile/account>
|
|
27 |
.TP
|
|
28 |
The variable GITLAB_API_HTTPARTY_OPTIONS is optional. It can be used to set any HTTParty option you may need using YAML hash syntax. For example SSL verification can be disabled with:
|
|
29 |
.sp
|
|
30 |
export GITLAB_API_HTTPARTY_OPTIONS="{verify: false}"
|
|
31 |
.
|
|
32 |
.SH EXAMPLES
|
|
33 |
.TP
|
|
34 |
To list users:
|
|
35 |
.B ruby-gitlab users
|
|
36 |
.TP
|
|
37 |
To get current user:
|
|
38 |
.B ruby-gitlab user
|
|
39 |
.TP
|
|
40 |
The result can be filtered:
|
|
41 |
.B ruby-gitlab user \-\-only=id,username
|
|
42 |
|
|
43 |
.B ruby-gitlab user \-\-except=email,bio
|
|
44 |
.SH SEE ALSO
|
|
45 |
.IP \(bu 2
|
|
46 |
gem documentation <http://www.rubydoc.info/gems/gitlab/Gitlab/Client>
|
|
47 |
.IP \(bu 2
|
|
48 |
/usr/share/doc/ruby\-gitlab/README.md.gz
|
|
49 |
.SH AUTHOR
|
|
50 |
Sophie Brun <sophie@freexian.com>
|
0 | |
debian/gitlab.1
|
|
0 |
debian/ruby-gitlab.1
|
3 | 3 |
|
4 | 4 |
%:
|
5 | 5 |
dh $@ --buildsystem=ruby --with ruby
|
|
6 |
|
|
7 |
override_dh_auto_install:
|
|
8 |
dh_auto_install $@
|
|
9 |
mv debian/ruby-gitlab/usr/bin/gitlab debian/ruby-gitlab/usr/bin/ruby-gitlab
|