@gitlab/duo-cli 8.29.1 → 8.30.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +43 -14
- package/dist/index.js +528 -528
- package/dist/index.js.map +9 -8
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -2,7 +2,46 @@
|
|
|
2
2
|
|
|
3
3
|
GitLab Duo CLI (`@gitlab/duo-cli`) - GitLab Duo for your command line.
|
|
4
4
|
|
|
5
|
-
##
|
|
5
|
+
## Installing
|
|
6
|
+
|
|
7
|
+
The Duo CLI can be installed from the npm registry using `npm`, `bun`, `yarn` etc:
|
|
8
|
+
|
|
9
|
+
```shell
|
|
10
|
+
npm install -g @gitlab/duo-cli
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
After installing, the CLI can be run with `duo`.
|
|
14
|
+
|
|
15
|
+
Alternatively, the CLI can be directly run without an explicit install:
|
|
16
|
+
|
|
17
|
+
```shell
|
|
18
|
+
npx -y @gitlab/duo-cli
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
### Updating
|
|
22
|
+
|
|
23
|
+
The CLI can be updated the same way you installed it, specifying `@latest` to ensure the latest version is installed:
|
|
24
|
+
|
|
25
|
+
```shell
|
|
26
|
+
npm install -g @gitlab/duo-cli@latest
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
### Usage
|
|
30
|
+
|
|
31
|
+
Run `duo` to start the CLI terminal UI. You will be prompted for an [authentication token](https://docs.gitlab.com/user/profile/personal_access_tokens/) on first run. Your token must have the `api` scope granted.
|
|
32
|
+
|
|
33
|
+
The CLI help text can be displayed with the `--help` flag, globally or per-command for more details:
|
|
34
|
+
|
|
35
|
+
```shell
|
|
36
|
+
duo --help
|
|
37
|
+
duo run --help
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
This will provide details of all available commands and flags.
|
|
41
|
+
|
|
42
|
+
## Contributing
|
|
43
|
+
|
|
44
|
+
### Prerequisites
|
|
6
45
|
|
|
7
46
|
This CLI project is built using [bun](https://bun.sh/). Make sure you have the following installed:
|
|
8
47
|
|
|
@@ -11,7 +50,7 @@ This CLI project is built using [bun](https://bun.sh/). Make sure you have the f
|
|
|
11
50
|
|
|
12
51
|
in order to continue working with the language server, install dependencies with npm package manager: `npm run install:npm`
|
|
13
52
|
|
|
14
|
-
|
|
53
|
+
### Compilation
|
|
15
54
|
|
|
16
55
|
To create standalone executables for distribution, use the compilation script:
|
|
17
56
|
|
|
@@ -27,7 +66,7 @@ This will create cross-platform executables in the `./bin` directory:
|
|
|
27
66
|
- `duo-darwin-arm64` - macOS Apple Silicon
|
|
28
67
|
- `duo-windows-x64.exe` - Windows 64-bit
|
|
29
68
|
|
|
30
|
-
|
|
69
|
+
#### Development
|
|
31
70
|
|
|
32
71
|
There are a few handy commands available for development:
|
|
33
72
|
|
|
@@ -42,17 +81,7 @@ cd packages/cli
|
|
|
42
81
|
npm run dev:watch -- --cwd /foo/bar # this passes through --cwd to the CLI, rather than npm itself getting the flag
|
|
43
82
|
```
|
|
44
83
|
|
|
45
|
-
###
|
|
46
|
-
|
|
47
|
-
The CLI help text can be displayed with the `--help` flag, globally or per-command for more details:
|
|
48
|
-
|
|
49
|
-
```shell
|
|
50
|
-
cd packages/cli
|
|
51
|
-
npm run dev:watch -- --help
|
|
52
|
-
npm run dev:watch -- run --help
|
|
53
|
-
```
|
|
54
|
-
|
|
55
|
-
## Troubleshooting
|
|
84
|
+
### Troubleshooting
|
|
56
85
|
|
|
57
86
|
If you have issues with Bun not resolving installed node_modules in the packages, you may need to clear node_modules folders and reinstall:
|
|
58
87
|
|