GitLab CLI library.
npm install cli-gitlabcli-gitlab
===========
Check node-gitlab
Dependencie on node-gitlab 1.7.0 or late
Quick Start
=====
You need to be very careful to set 'gitlab url'.
Please make sure your settings are 'http' or 'https'.
``bashInstall from npm for global
npm install cli-gitlab -gYou will see all command
gitlab --helpFor example
gitlab url "http://example.com"
gitlab token "abcdefghij123456"
gitlab me
{
"avatar_url": "http://gitlab.baidao.com//uploads/user/avatar/9/764b89699bcc946e4239b04f28002ce9.jpeg",
"bio": "",
"can_create_group": true,
"can_create_project": true,
"color_scheme_id": 1,
"created_at": "2014-08-06T03:30:19.417Z",
"email": "jun.cao@baidao.com",
"extern_uid": null,
"id": 9,
......
}
`
Extend Usage
=============
`
gitlab map test.json
test.json:
{
"t": {
"filter": true,
"size": true,
"param": ["
"desc": "Search user by email or username.",
"nameSpaces": "users.search"
}
}
`
gitlab t --help
Usage: t [options]
Search user by email or username.
Options:
-h, --help output usage information
--size (optional) - Output size of result.
--filter
`
Check map rule
'nameSpaces' please check node-gitlab
For example:
`In Projects.coffee
class Projects extends BaseModel ==> projects
@members = @load 'ProjectMembers' ===> memebers
By the way, the 'extend' function is used by undersore.extend.
Filter Usage
=============
gitlab issues --help Usage: issues [options]
Get all issues created by authenticated user. This function takes pagination parameters page and per_page to restrict the list of issues.
Options:
-h, --help output usage information
-s, --state [state] (optional) - Return all issues or just those that are opened or closed
-l, --labels [labels] (optional) - Comma-separated list of label names
-o, --order_by [order_by] (optional) - Return requests ordered by created_at or updated_at fields. Default is created_at
-d, --sort [sort] (optional) - Return requests sorted in asc or desc order. Default is desc
-e, --per_page [per_page] (optional) - The limit of list.
-p, --page [page] (optional) - The offset of list.
--assigned_to_me (optional) - Filter result if assigned to me.
--size [size] (optional) - Output size of result.
--filter (optional) - Filter result. For example: --filter 'item.assignee.id == 9'
"item" means current object, so aways use "item.xx"
gitlab issues --filter "item.assignee.id==9" --state closed
[
...
{
"assignee": {
"avatar_url": "http://gitlab.baidao.com//uploads/user/avatar/9/764b89699bcc946e4239b04f28002ce9.jpeg",
"id": 9,
"name": "Cao Jun",
"state": "active",
"username": "mdsb100"
},
"author": {
"avatar_url": "http://gitlab.baidao.com//uploads/user/avatar/9/764b89699bcc946e4239b04f28002ce9.jpeg",
"id": 9,
"name": "Cao Jun",
"state": "active",
"username": "mdsb100"
},
"created_at": "2014-08-14T06:28:20.398Z",
"description": "测试一下",
"id": 2,
"iid": 1,
"labels": [
],
"milestone": null,
"project_id": 10,
"state": "closed",
"title": "Test Issue",
"updated_at": "2014-08-15T10:25:31.588Z"
},
...
]Assigned to me. Created by me. Size
===================================
gitlab issues --assigned_to_me --created_by_me --state opened --size
[
{
"assignee": {
"avatar_url": "http://gitlab.baidao.com//uploads/user/avatar/9/764b89699bcc946e4239b04f28002ce9.jpeg",
"id": 9,
"name": "Cao Jun",
"state": "active",
"username": "mdsb100"
},
"author": {
"avatar_url": "http://gitlab.baidao.com//uploads/user/avatar/9/764b89699bcc946e4239b04f28002ce9.jpeg",
"id": 9,
"name": "Cao Jun",
"state": "active",
"username": "mdsb100"
},
"created_at": "2015-01-06T09:07:04.626Z",
"description": "使用time_t（秒数）来计算时间\r\n使用tm来结构化时间",
"id": 274,
"iid": 5,
"labels": [
],
"milestone": null,
"project_id": 12,
"state": "opened",
"title": "把boost依赖移除",
"updated_at": "2015-01-06T09:07:04.626Z"
}
]
1gitlab me
{
......
"id": 9,
"is_admin": false,
"linkedin": "",
"name": "Cao Jun",
......
}
Issues Usage
=============
Refernce issues
gitlab createIssue --help Usage: createIssue [options]
Creates a new project issue.If the operation is successful, 200 and the newly created issue is returned. If an error occurs, an error number and a message explaining the reason is returned.
Options:
-h, --help output usage information
-t, --title
(required) - The title of an issue.<br /> -d, --description [desc] (optional) - The description of an issue.<br /> -a, --assignee_id [assignee_id] (optional) - The ID of a user to assign issue.<br /> -m, --milestone_id [milestone_id] (optional) - The ID of a milestone to assign issue.<br /> -l, --labels [labels] (optional) - Comma-separated label names for an issue.<br /> -dd, --due_date [due_date] (optional) - Date time string in the format YEAR-MONTH-DAY, e.g. 2016-03-11</p><p class="my-3"></code>`<code class="bg-muted px-1 py-0.5 rounded text-sm font-mono"></p><p class="my-3"></code>`<code class="bg-muted px-1 py-0.5 rounded text-sm font-mono"><br />gitlab createIssue 12 -t test -a 9</p><p class="my-3">{<br /> "assignee": {<br /> "avatar_url": "http://gitlab.baidao.com//uploads/user/avatar/9/764b89699bcc946e4239b04f28002ce9.jpeg",<br /> "id": 9,<br /> "name": "Cao Jun",<br /> "state": "active",<br /> "username": "mdsb100"<br /> },<br /> "author": {<br /> "avatar_url": "http://gitlab.baidao.com//uploads/user/avatar/9/764b89699bcc946e4239b04f28002ce9.jpeg",<br /> "id": 9,<br /> "name": "Cao Jun",<br /> "state": "active",<br /> "username": "mdsb100"<br /> },<br /> "created_at": "2015-02-10T03:53:53.341Z",<br /> "description": null,<br /> "id": 807,<br /> "iid": 7,<br /> "labels": [<br /> ],<br /> "milestone": null,<br /> "project_id": 12,<br /> "state": "opened",<br /> "title": "test",<br /> "updated_at": "2015-02-10T03:53:53.341Z"<br />}<br /></code>`<code class="bg-muted px-1 py-0.5 rounded text-sm font-mono"></p><p class="my-3"></code>`<code class="bg-muted px-1 py-0.5 rounded text-sm font-mono"><br />gitlab editIssue --help</p><p class="my-3"> Usage: editIssue [options] <projectId> <issueId></p><p class="my-3"> Updates an existing project issue. This function is also used to mark an issue as closed.If the operation is successful, 200 and the updated issue is returned. If an error occurs, an error number and a message explaining the reason is returned.</p><p class="my-3"> Options:</p><p class="my-3"> -h, --help output usage information<br /> -t, --title [title] (optional) - The title of an issue.<br /> -d, --description [desc] (optional) - The description of an issue.<br /> -a, --assignee_id [assignee_id] (optional) - The ID of a user to assign issue.<br /> -m, --milestone_id [milestone_id] (optional) - The ID of a milestone to assign issue.<br /> -l, --labels [labels] (optional) - Comma-separated label names for an issue.<br /> -s, --state_event [state_event] (optional) - The state event of an issue ('close' to close issue and 'reopen' to reopen it).<br /> -dd, --due_date [due_date] (optional) - Date time string in the format YEAR-MONTH-DAY, e.g. 2016-03-11<br /></code>`<code class="bg-muted px-1 py-0.5 rounded text-sm font-mono"></p><p class="my-3"></code>`<code class="bg-muted px-1 py-0.5 rounded text-sm font-mono"><br />gitlab editIssue 12 807 -t test_it -d totest</p><p class="my-3">{<br /> "assignee": {<br /> "avatar_url": "http://gitlab.baidao.com//uploads/user/avatar/9/764b89699bcc946e4239b04f28002ce9.jpeg",<br /> "id": 9,<br /> "name": "Cao Jun",<br /> "state": "active",<br /> "username": "mdsb100"<br /> },<br /> "author": {<br /> "avatar_url": "http://gitlab.baidao.com//uploads/user/avatar/9/764b89699bcc946e4239b04f28002ce9.jpeg",<br /> "id": 9,<br /> "name": "Cao Jun",<br /> "state": "active",<br /> "username": "mdsb100"<br /> },<br /> "created_at": "2015-02-10T03:53:53.341Z",<br /> "description": "totest",<br /> "id": 807,<br /> "iid": 7,<br /> "labels": [<br /> ],<br /> "milestone": null,<br /> "project_id": 12,<br /> "state": "opened",<br /> "title": "test_it",<br /> "updated_at": "2015-02-10T04:03:35.287Z"<br />}</p><p class="my-3"></code>``</p><p class="my-3"><a href="https://github.com/mdsb100/cli-gitlab/blob/master/bin/map.coffee" class="text-primary hover:underline" target="_blank" rel="noopener noreferrer">List of commands</a><br />----------------<br />- groups<br />- showGroup<br />- showGroupProjects<br />- showGroupMembers<br />- addGroupMember<br />- createGroup<br />- transferProjectToGroup<br />- searchGroup<br />- issueNotes<br />- issues<br />- showIssue<br />- createIssue<br />- editIssue<br />- createLabel<br />- createNote<br />- keys<br />- getKey<br />- addKey<br />- hooks<br />- showHook<br />- addHook<br />- updateHook<br />- removeHook<br />- projectIssues<br />- projectLabels<br />- members<br />- showMember<br />- addMember<br />- updateMember<br />- removeMember<br />- mergeRequests<br />- showMergeRequest<br />- addMergeRequest<br />- updateMergeRequest<br />- commentMergeRequest<br />- milestones<br />- showMilestones<br />- addMilestones<br />- updateMilestones<br />- branches<br />- showBranch<br />- protectBranch<br />- unprotectBranch<br />- createBranch<br />- deleteBranch<br />- tags<br />- commits<br />- showCommit<br />- diffCommit<br />- trees<br />- projects<br />- showProject<br />- createProject<br />- createProjectForUser<br />- updateProject<br />- projectsAdminOnly<br />- removeProject<br />- forkProject<br />- searchProject<br />- triggersOfProject<br />- showProjectService<br />- removeProjectService<br />- addUserKey<br />- userKeys<br />- addUserKey<br />- users<br />- me<br />- showUser<br />- createUser<br />- session<br />- searchUsers</p><p class="my-3">Thank<br />------------<br /><a href="https://github.com/dave-irvine" class="text-primary hover:underline" target="_blank" rel="noopener noreferrer">Dave Irvine</a></p><p class="my-3">License<br />-------<br />MIT<br /></p></div><div class="flex justify-center absolute inset-x-0 bottom-0 bg-gradient-to-t from-background via-background to-transparent pb-4 pt-16"><button data-slot="button" class="inline-flex items-center justify-center whitespace-nowrap text-sm font-medium transition-all disabled:pointer-events-none disabled:opacity-50 [&_svg]:pointer-events-none [&_svg:not([class*='size-'])]:size-4 shrink-0 [&_svg]:shrink-0 outline-none focus-visible:border-ring focus-visible:ring-ring/50 focus-visible:ring-[3px] aria-invalid:ring-destructive/20 dark:aria-invalid:ring-destructive/40 aria-invalid:border-destructive border bg-background shadow-xs hover:bg-accent hover:text-accent-foreground dark:bg-input/30 dark:border-input dark:hover:bg-input/50 h-8 rounded-md gap-1.5 px-3 has-[>svg]:px-2.5"><svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="lucide lucide-chevron-down mr-1 h-4 w-4"><path d="m6 9 6 6 6-6"></path></svg>Show more</button></div></div></div><template id="P:3"></template><template id="P:4"></template></div></div></div><script>self.__next_f.push([1,"26:[\"$\",\"path\",\"mthhwq\",{\"d\":\"m9 18 6-6-6-6\"}]\n27:[\"$\",\"span\",null,{\"className\":\"ml-2 shrink-0 font-mono text-xs text-muted-foreground\",\"children\":\"latest\"}]\n28:[\"$\",\"$L5\",\"nconf\",{\"href\":\"/package/nconf\",\"className\":\"group flex items-center justify-between rounded-md px-2 py-1.5 text-sm transition-colors hover:bg-accent\",\"children\":[[\"$\",\"span\",null,{\"className\":\"flex items-center gap-1.5 truncate font-mono text-foreground\",\"children\":[[\"$\",\"svg\",null,{\"ref\":\"$undefined\",\"xmlns\":\"http://www.w3.org/2000/svg\",\"width\":24,\"height\":24,\"viewBox\":\"0 0 24 24\",\"fill\":\"none\",\"stroke\":\"currentColor\",\"strokeWidth\":2,\"strokeLinecap\":\"round\",\"strokeLinejoin\":\"round\",\"className\":\"lucide lucide-chevron-right h-3 w-3 text-muted-foreground opacity-0 transition-opacity group-hover:opacity-100\",\"children\":[[\"$\",\"path\",\"mthhwq\",{\"d\":\"m9 18 6-6-6-6\"}],\"$undefined\"]}],\"nconf\"]}],[\"$\",\"span\",null,{\"className\":\"ml-2 shrink-0 font-mono text-xs text-muted-foreground\",\"children\":\"latest\"}]]}]\n29:[\"$\",\"$L5\",\"underscore\",{\"href\":\"/package/underscore\",\"className\":\"group flex items-center justify-between rounded-md px-2 py-1.5 text-sm transition-colors hover:bg-accent\",\"children\":[[\"$\",\"span\",null,{\"className\":\"flex items-center gap-1.5 truncate font-mono text-foreground\",\"children\":[[\"$\",\"svg\",null,{\"ref\":\"$undefined\",\"xmlns\":\"http://www.w3.org/2000/svg\",\"width\":24,\"height\":24,\"viewBox\":\"0 0 24 24\",\"fill\":\"none\",\"stroke\":\"currentColor\",\"strokeWidth\":2,\"strokeLinecap\":\"round\",\"strokeLinejoin\":\"round\",\"className\":\"lucide lucide-chevron-right h-3 w-3 text-muted-foreground opacity-0 transition-opacity group-hover:opacity-100\",\"children\":[[\"$\",\"path\",\"mthhwq\",{\"d\":\"m9 18 6-6-6-6\"}],\"$undefined\"]}],\"underscore\"]}],[\"$\",\"span\",null,{\"className\":\"ml-2 shrink-0 font-mono text-xs text-muted-foreground\",\"children\":\"1.7.0\"}]]}]\n"])</script><div hidden id="S:3"><div data-state="inactive" data-orientation="horizontal" role="tabpanel" aria-labelledby="radix-_R_aav5ubrb_-trigger-dependencies" hidden="" id="radix-_R_aav5ubrb_-content-dependencies" tabindex="0" data-slot="tabs-content" class="flex-1 outline-none mt-6"></div></div><script>$RS=function(a,b){a=document.getElementById(a);b=document.getElementById(b);for(a.parentNode.removeChild(a);a.firstChild;)b.parentNode.insertBefore(a.firstChild,b);b.parentNode.removeChild(b)};$RS("S:3","P:3")</script><div hidden id="S:4"><div data-state="inactive" data-orientation="horizontal" role="tabpanel" aria-labelledby="radix-_R_aav5ubrb_-trigger-versions" hidden="" id="radix-_R_aav5ubrb_-content-versions" tabindex="0" data-slot="tabs-content" class="flex-1 outline-none mt-6"></div></div><script>$RS("S:4","P:4")</script><script>$RC("B:1","S:1")</script></body></html>