Repository navigation
Commit f33c523
docs(cli): make examples more easily navigable by generating TOC
1 parent 55c67d1 commit f33c523
1 file changed
Lines changed: 27 additions & 0 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -6,6 +6,9 @@ CLI examples | |||
| 6 | 6 | ||
| 7 | 7 | For a complete list of objects and actions available, see :doc:`/cli-objects`. | |
| 8 | 8 | ||
| 9 | + Projects | ||
| 10 | + -------- | ||
| 11 | + | ||
| 9 | 12 | List the projects (paginated): | |
| 10 | 13 | ||
| 11 | 14 | .. code-block:: console | |
@@ -42,12 +45,18 @@ Get a specific project (id 2): | |||
| 42 | 45 | ||
| 43 | 46 | $ gitlab project get --id 2 | |
| 44 | 47 | ||
| 48 | + Users | ||
| 49 | + ----- | ||
| 50 | + | ||
| 45 | 51 | Get a specific user by id: | |
| 46 | 52 | ||
| 47 | 53 | .. code-block:: console | |
| 48 | 54 | ||
| 49 | 55 | $ gitlab user get --id 3 | |
| 50 | 56 | ||
| 57 | + Deploy tokens | ||
| 58 | + ------------- | ||
| 59 | + | ||
| 51 | 60 | Create a deploy token for a project: | |
| 52 | 61 | ||
| 53 | 62 | .. code-block:: console | |
@@ -61,6 +70,9 @@ List deploy tokens for a group: | |||
| 61 | 70 | ||
| 62 | 71 | $ gitlab -v group-deploy-token list --group-id 3 | |
| 63 | 72 | ||
| 73 | + Packages | ||
| 74 | + -------- | ||
| 75 | + | ||
| 64 | 76 | List packages for a project: | |
| 65 | 77 | ||
| 66 | 78 | .. code-block:: console | |
@@ -99,12 +111,18 @@ Download a project's generic package: | |||
| 99 | 111 | $ gitlab generic-package download --project-id 1 --package-name hello-world \ | |
| 100 | 112 | --package-version v1.0.0 --file-name hello.tar.gz > /path/to/hello.tar.gz | |
| 101 | 113 | ||
| 114 | + Issues | ||
| 115 | + ------ | ||
| 116 | + | ||
| 102 | 117 | Get a list of issues for this project: | |
| 103 | 118 | ||
| 104 | 119 | .. code-block:: console | |
| 105 | 120 | ||
| 106 | 121 | $ gitlab project-issue list --project-id 2 | |
| 107 | 122 | ||
| 123 | + Snippets | ||
| 124 | + -------- | ||
| 125 | + | ||
| 108 | 126 | Delete a snippet (id 3): | |
| 109 | 127 | ||
| 110 | 128 | .. code-block:: console | |
@@ -128,6 +146,9 @@ Create a snippet: | |||
| 128 | 146 | $ gitlab project-snippet create --project-id 2 --title "the title" \ | |
| 129 | 147 | --file-name "the name" --code "the code" | |
| 130 | 148 | ||
| 149 | + Commits | ||
| 150 | + ------- | ||
| 151 | + | ||
| 131 | 152 | Get a specific project commit by its SHA id: | |
| 132 | 153 | ||
| 133 | 154 | .. code-block:: console | |
@@ -149,12 +170,18 @@ Define the status of a commit (as would be done from a CI tool for example): | |||
| 149 | 170 | --target-url http://server/build/123 \ | |
| 150 | 171 | --description "Jenkins build succeeded" | |
| 151 | 172 | ||
| 173 | + Artifacts | ||
| 174 | + --------- | ||
| 175 | + | ||
| 152 | 176 | Download the artifacts zip archive of a job: | |
| 153 | 177 | ||
| 154 | 178 | .. code-block:: console | |
| 155 | 179 | ||
| 156 | 180 | $ gitlab project-job artifacts --id 10 --project-id 1 > artifacts.zip | |
| 157 | 181 | ||
| 182 | + Other | ||
| 183 | + ----- | ||
| 184 | + | ||
| 158 | 185 | Use sudo to act as another user (admin only): | |
| 159 | 186 | ||
| 160 | 187 | .. code-block:: console | |
0 commit comments