Skip to content

Commit 5ee88fe

Browse files
committed
readme update [ci skip]
1 parent 7d4ba3e commit 5ee88fe

File tree

1 file changed

+31
-22
lines changed

1 file changed

+31
-22
lines changed

README.md

Lines changed: 31 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -44,24 +44,25 @@ gitlabctl completion -h
4444

4545
## Quickstart
4646

47-
### Using the help commands
47+
### Authenticating to Gitlab server
48+
49+
Using `gitlabctl login` to fetch personal access token
4850

4951
```bash
50-
# get commands is used to list resources
51-
gitlabctl get [subcommand] -h
52+
>> gitlabctl login
53+
>> Enter gitlab host url: http://localhost:10080
54+
>> Enter gitlab username: root
55+
>> Enter gitlab password: *****
56+
/Users/jb/.gitlabctl.yaml file has been created by login command
57+
```
5258

53-
# new commands is used to create a single resource
54-
gitlabctl new [subcommand] -h
59+
Using environment variables. See `gitlabctl -h`
5560

56-
# edit commands is used to update a single resource
57-
gitlabctl edit [subcommand] -h
61+
### Using the help commands
5862

59-
# delete commands is used to delete a single resource
60-
gitlabctl delete [subcommand] -h
63+
Use __-h__ flag when possible.
6164

62-
# describe command is used to describe a single resource
63-
gitlabctl describe [subcommand] -h
64-
```
65+
`gitlabctl [command] -h` or `gitlabctl [command] [subcommand] -h`
6566

6667
### Usage Examples
6768

@@ -197,21 +198,29 @@ Contributors are welcomed with love! Please read [CONTRIBUTING.md](./CONTRIBUTIN
197198
* [x] `edit project [project id or project path] [flags]`
198199
* [x] `delete project [project id or project path]`
199200

200-
### Project Repository Branch
201+
### Project/Repository Branch
202+
203+
* [ ] `get branch [project id or project path] [flags]`
204+
* [x] `describe branch [branch name] [--project] [flags]`
205+
* [x] `new branch [branch name] [--project] [flags]`
206+
* [x] `delete branch [branch name] [--project]`
207+
* [ ] `protect-branch [branch name] [--project] [flags]`
208+
* [ ] `unprotect-branch [branch name] [--project]`
209+
210+
### Project/Repository Tags
201211

202-
* [ ] `get branch [flags]`
203-
* [x] `describe branch [branch name] [flags]`
204-
* [x] `new branch [branch name] [flags]`
205-
* [x] `delete branch [branch name] [flags]`
206-
* [ ] `edit branch [branch name] [--protect] [flags]`
207-
* [ ] `edit branch [branch name] [--unprotect] [flags]`
212+
* [ ] `get tags [project id or project path] [flags]`
213+
* [ ] `describe tag [tag name] [--project] [flags]`
214+
* [ ] `new tag [tag name] [--project] [flags]`
215+
* [ ] `edit tag [tag name] [--project] [flags]`
216+
* [ ] `delete tag [tag name] [--project]`
208217

209218
### Project Hooks
210219

211-
* [x] `get project-hooks [project id or project path]`
220+
* [x] `get project-hooks [project id or project path] [flags]`
212221
* [x] `new project-hook [project id or project path] [flags]`
213-
* [x] `edit project-hook [project id or project path] [flags]`
214-
* [ ] `delete project-hook [hook id]`
222+
* [x] `edit project-hook [hook id] [--project] [flags]`
223+
* [x] `delete project-hook [hook id] [--project]`
215224

216225
### Users
217226

0 commit comments

Comments
 (0)