Skip to content
This repository was archived by the owner on Jun 1, 2022. It is now read-only.

Commit 4813671

Browse files
Update README
1 parent e7ba9d3 commit 4813671

File tree

1 file changed

+42
-40
lines changed

1 file changed

+42
-40
lines changed

README.md

Lines changed: 42 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Please getting source code and build.
1414
```sh
1515
go get github.com/lighttiger2505/lab
1616
make ensure
17-
go install
17+
make install
1818
```
1919

2020
### Binary download
@@ -33,13 +33,19 @@ The script installs the `lab` command in `/usr/local/bin`. For more details, see
3333
Usage: lab [--version] [--help] <command> [<args>]
3434
3535
Available commands are:
36-
browse Browse repository page
37-
issue Create and Edit, list a issue
38-
lint validate .gitlab-ci.yml
39-
merge-request Create and Edit, list a merge request
40-
pipeline List pipeline, List pipeline jobs
41-
project Show project
42-
user Show pipeline
36+
browse Browse project page
37+
issue Create and Edit, list a issue
38+
issue-template List issue template
39+
job List job
40+
lint validate .gitlab-ci.yml
41+
merge-request Create and Edit, list a merge request
42+
merge-request-template List merge request template
43+
mr Create and Edit, list a merge request
44+
pipeline List pipeline, List pipeline jobs
45+
project List project
46+
project-variable List project level variables
47+
runner List CI/CD Runner
48+
user List user
4349
```
4450

4551
## Usage
@@ -66,58 +72,54 @@ Available commands are:
6672
Open gitlab pages on brwoser.
6773

6874
```sh
69-
# open project page
75+
# Browse project page
7076
$ lab browse
7177

72-
# open issue list page
73-
$ lab browse #
74-
$ lab browse i
78+
# Browse project file
79+
$ lab browse ./README.md
7580

76-
# open issue detail page
77-
$ lab browse #10
78-
$ lab browse i10
81+
# Browse sub page
82+
$ lab browse -s issues
7983
```
8084

81-
### List Issue and Merge Request
85+
### Operations to Issue and Merge Request
8286

83-
Show any list.
87+
Many operations can be done with simple input.
8488

8589
```sh
86-
# List Issue
87-
$ lab issue
90+
# List issue
91+
lab issue
8892

89-
# List Merge Request
90-
$ lab merge-request
91-
```
92-
93-
### Add Issue and Merge Request
93+
# Browse issue
94+
lab issue -b {issue ii}
9495

95-
title and description input on editor.
96+
# Show issue
97+
lab issue {issue id}
9698

97-
```sh
98-
# Add Issue
99-
$ lab add-issue
99+
# Create issue
100+
lab issue -e
100101

101-
# Add Merge Request
102-
$ lab add-merge-request --target={target branch}
102+
# Update issue
103+
lab issue {issue id} -e
103104
```
104105

105106
## Configuration
106107

107-
auto create configuration file `~/.labconfig.yml` when launch lab command
108+
auto create configuration file `~/.config/lab/config.yml` when launch lab command
108109

109110
### Sample
110111

111112
```yml
112-
# personal access token
113-
# store key/value style
114-
tokens:
115-
gitlab.ssl.sample.jp: sampletoken
116-
gitlab.ssl.lowpriority.jp: lowprioritytoken
117-
# Determine priority when there are multiple pieces of remote information in the repository
118-
preferreddomains:
119-
- gitlab.ssl.sample.jp
120-
- gitlab.ssl.lowpriority.jp
113+
default_profile: gitlab.com:
114+
profiles:
115+
gitlab.com:
116+
token: ********************
117+
default_group: hoge
118+
default_project: hoge/soge
119+
gitlab.ssl.foo.jp:
120+
token: ********************
121+
default_group: foo
122+
default_project: foo/bar
121123
```
122124
123125
## ToDos

0 commit comments

Comments
 (0)