@gitlab/duo-cli 8.22.0 → 8.24.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 CHANGED
@@ -31,10 +31,27 @@ This will create cross-platform executables in the `./bin` directory:
31
31
 
32
32
  There are a few handy commands available for development:
33
33
 
34
- - `watch` - starts the application with bun in watch mode. The application will be automatically restarted if code changes are made
34
+ - `dev:watch` - starts the application with bun in watch mode. The application will be automatically restarted if code changes are made
35
35
  - `dev:watch-tools` - as above, but react devtools will be started alongside connected to the application
36
36
  - `start` - compiles the application to js and starts it. This is exactly the version of the app that will be packaged to the npm package. It is recommended to test your changes with it before creating an MR
37
37
 
38
+ When using the `package.json` scripts, use `--` to separate flags between npm/CLI. For example:
39
+
40
+ ```shell
41
+ cd packages/cli
42
+ npm run dev:watch -- --cwd /foo/bar # this passes through --cwd to the CLI, rather than npm itself getting the flag
43
+ ```
44
+
45
+ ### Usage
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
+
38
55
  ## Troubleshooting
39
56
 
40
57
  If you have issues with Bun not resolving installed node_modules in the packages, you may need to clear node_modules folders and reinstall: