hookdeck-cli 1.10.0-beta.4 → 2.0.0-beta.1
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 +28 -12
- package/binaries/darwin-amd64/hookdeck +0 -0
- package/binaries/darwin-arm64/hookdeck +0 -0
- package/binaries/linux-amd64/hookdeck +0 -0
- package/binaries/linux-arm64/hookdeck +0 -0
- package/binaries/win32-386/hookdeck.exe +0 -0
- package/binaries/win32-amd64/hookdeck.exe +0 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -40,6 +40,7 @@ For a complete reference of all commands and flags, see [REFERENCE.md](REFERENCE
|
|
|
40
40
|
- [Transformations](#transformations)
|
|
41
41
|
- [Requests, events, and attempts](#requests-events-and-attempts)
|
|
42
42
|
- [Manage active project](#manage-active-project)
|
|
43
|
+
- [Telemetry](#telemetry)
|
|
43
44
|
- [Configuration files](#configuration-files)
|
|
44
45
|
- [Global Flags](#global-flags)
|
|
45
46
|
- [Troubleshooting](#troubleshooting)
|
|
@@ -731,7 +732,7 @@ By default, `project use` saves your selection to the **global configuration** (
|
|
|
731
732
|
|
|
732
733
|
The CLI uses exactly one configuration file based on this precedence:
|
|
733
734
|
|
|
734
|
-
1. **Custom config** (via `--config` flag) - highest priority
|
|
735
|
+
1. **Custom config** (via `--hookdeck-config` flag) - highest priority
|
|
735
736
|
2. **Local config** - `${PWD}/.hookdeck/config.toml` (if exists)
|
|
736
737
|
3. **Global config** - `~/.config/hookdeck/config.toml` (default)
|
|
737
738
|
|
|
@@ -781,11 +782,11 @@ This ensures your directory-specific configuration is preserved when it exists.
|
|
|
781
782
|
hookdeck project use my-org my-project
|
|
782
783
|
hookdeck project use my-org my-project --local
|
|
783
784
|
|
|
784
|
-
# ❌ Invalid (cannot combine --config with --local)
|
|
785
|
-
hookdeck --config custom.toml project use my-org my-project --local
|
|
786
|
-
Error: --local and --config flags cannot be used together
|
|
785
|
+
# ❌ Invalid (cannot combine --hookdeck-config with --local)
|
|
786
|
+
hookdeck --hookdeck-config custom.toml project use my-org my-project --local
|
|
787
|
+
Error: --local and --hookdeck-config flags cannot be used together
|
|
787
788
|
--local creates config at: .hookdeck/config.toml
|
|
788
|
-
--config uses custom path: custom.toml
|
|
789
|
+
--hookdeck-config uses custom path: custom.toml
|
|
789
790
|
```
|
|
790
791
|
|
|
791
792
|
#### Benefits of local project pinning
|
|
@@ -1094,6 +1095,20 @@ $ hookdeck gateway connection delete conn_123abc --force
|
|
|
1094
1095
|
|
|
1095
1096
|
For complete flag documentation and all examples, see [REFERENCE.md](REFERENCE.md).
|
|
1096
1097
|
|
|
1098
|
+
### Telemetry
|
|
1099
|
+
|
|
1100
|
+
The Hookdeck CLI collects anonymous telemetry to help improve the tool. You can opt out at any time:
|
|
1101
|
+
|
|
1102
|
+
```sh
|
|
1103
|
+
# Disable telemetry
|
|
1104
|
+
hookdeck telemetry disabled
|
|
1105
|
+
|
|
1106
|
+
# Re-enable telemetry
|
|
1107
|
+
hookdeck telemetry enabled
|
|
1108
|
+
```
|
|
1109
|
+
|
|
1110
|
+
You can also disable telemetry by setting the `HOOKDECK_CLI_TELEMETRY_DISABLED` environment variable to `1` or `true`.
|
|
1111
|
+
|
|
1097
1112
|
## Configuration files
|
|
1098
1113
|
|
|
1099
1114
|
The Hookdeck CLI uses configuration files to store the your keys, project settings, profiles, and other configurations.
|
|
@@ -1102,9 +1117,10 @@ The Hookdeck CLI uses configuration files to store the your keys, project settin
|
|
|
1102
1117
|
|
|
1103
1118
|
The CLI will look for the configuration file in the following order:
|
|
1104
1119
|
|
|
1105
|
-
1. The `--config` flag, which allows you to specify a custom configuration file
|
|
1106
|
-
2. The
|
|
1107
|
-
3. The
|
|
1120
|
+
1. The `--hookdeck-config` flag, which allows you to specify a custom configuration file path per command.
|
|
1121
|
+
2. The `HOOKDECK_CONFIG_FILE` environment variable (path to the config file).
|
|
1122
|
+
3. The local directory `.hookdeck/config.toml`.
|
|
1123
|
+
4. The default global configuration file location.
|
|
1108
1124
|
|
|
1109
1125
|
### Default configuration Location
|
|
1110
1126
|
|
|
@@ -1179,7 +1195,7 @@ The following flags can be used with any command:
|
|
|
1179
1195
|
|
|
1180
1196
|
- `--api-key`: Your API key to use for the command.
|
|
1181
1197
|
- `--color`: Turn on/off color output (on, off, auto).
|
|
1182
|
-
- `--config`: Path to
|
|
1198
|
+
- `--hookdeck-config`: Path to the CLI configuration file. You can also set the `HOOKDECK_CONFIG_FILE` environment variable to the config file path.
|
|
1183
1199
|
- `--device-name`: A unique name for your device.
|
|
1184
1200
|
- `--insecure`: Allow invalid TLS certificates.
|
|
1185
1201
|
- `--log-level`: Set the logging level (debug, info, warn, error).
|
|
@@ -1221,16 +1237,16 @@ go run main.go
|
|
|
1221
1237
|
|
|
1222
1238
|
### Generating REFERENCE.md
|
|
1223
1239
|
|
|
1224
|
-
The [REFERENCE.md](REFERENCE.md) file is generated from Cobra command metadata. After changing commands, flags, or help text, regenerate it:
|
|
1240
|
+
The [REFERENCE.md](REFERENCE.md) file is generated from Cobra command metadata. After changing commands, flags, or help text, regenerate it in place:
|
|
1225
1241
|
|
|
1226
1242
|
```sh
|
|
1227
|
-
go run ./tools/generate-reference
|
|
1243
|
+
go run ./tools/generate-reference
|
|
1228
1244
|
```
|
|
1229
1245
|
|
|
1230
1246
|
To validate that REFERENCE.md is up to date (useful in CI):
|
|
1231
1247
|
|
|
1232
1248
|
```sh
|
|
1233
|
-
go run ./tools/generate-reference --
|
|
1249
|
+
go run ./tools/generate-reference --check
|
|
1234
1250
|
```
|
|
1235
1251
|
|
|
1236
1252
|
Build from source by running:
|
|
Binary file
|
|
Binary file
|
|
Binary file
|
|
Binary file
|
|
Binary file
|
|
Binary file
|