@@ -51,10 +51,16 @@ All commands support these global options:
5151--help, -h Show help information
5252```
5353
54- ### 🚧 Planned Global Options
54+ ### 🔄 Partially Implemented Options
55+ ``` bash
56+ --output json Output in JSON format (available on: connection create/list/get/upsert)
57+ Default: human-readable format
58+ ```
59+
60+ ### � Planned Global Options
5561``` bash
5662--project string Project ID to use (overrides profile)
57- --format string Output format : table, json, yaml (default " table " )
63+ --output string Additional output formats : table, yaml (currently only json supported )
5864```
5965
6066## Authentication
@@ -293,7 +299,7 @@ The Hookdeck CLI provides comprehensive connection management capabilities. The
293299| Project Management | 🔄 ** Partial** | ` project list ` , ` project use ` |
294300| Local Development | ✅ ** Current** | ` listen ` |
295301| CI/CD | ✅ ** Current** | ` ci ` |
296- | Connection Management | ✅ ** Current** | ` connection create ` , ` connection list ` , ` connection get ` , ` connection upsert ` , ` connection delete ` , ` connection enable ` , ` connection disable ` , ` connection pause ` , ` connection unpause ` , ` connection archive ` , ` connection unarchive ` |
302+ | Connection Management | ✅ ** Current** | ` connection create ` , ` connection list ` , ` connection get ` , ` connection upsert ` , ` connection delete ` , ` connection enable ` , ` connection disable ` , ` connection pause ` , ` connection unpause ` |
297303| Shell Completion | ✅ ** Current** | ` completion ` (bash, zsh) |
298304| Source Management | 🚧 ** Planned** | * (Not implemented)* |
299305| Destination Management | 🚧 ** Planned** | * (Not implemented)* |
@@ -450,7 +456,7 @@ hookdeck project delete proj_123 --force
450456< source-id> # Required positional argument for source ID
451457--force # Force delete without confirmation (boolean flag)
452458
453- # Source enable/disable/archive/unarchive command parameters
459+ # Source enable/disable command parameters
454460< source-id> # Required positional argument for source ID
455461```
456462
@@ -662,12 +668,6 @@ hookdeck source enable <source-id>
662668
663669# Disable source
664670hookdeck source disable < source-id>
665-
666- # Archive source
667- hookdeck source archive < source-id>
668-
669- # Unarchive source
670- hookdeck source unarchive < source-id>
671671```
672672
673673## Destinations
@@ -729,7 +729,7 @@ hookdeck source unarchive <source-id>
729729< destination-id> # Required positional argument for destination ID
730730--force # Force delete without confirmation (boolean flag)
731731
732- # Destination enable/disable/archive/unarchive command parameters
732+ # Destination enable/disable command parameters
733733< destination-id> # Required positional argument for destination ID
734734```
735735
@@ -863,12 +863,6 @@ hookdeck destination enable <destination-id>
863863
864864# Disable destination
865865hookdeck destination disable < destination-id>
866-
867- # Archive destination
868- hookdeck destination archive < destination-id>
869-
870- # Unarchive destination
871- hookdeck destination unarchive < destination-id>
872866```
873867
874868## Connections
@@ -883,7 +877,6 @@ hookdeck destination unarchive <destination-id>
883877- ` connection delete ` - Delete connections with confirmation
884878- ` connection enable/disable ` - Control connection state
885879- ` connection pause/unpause ` - Pause/resume event processing
886- - ` connection archive/unarchive ` - Archive inactive connections
887880
888881** Implementation Status:**
889882- ✅ Full CRUD operations
@@ -902,36 +895,34 @@ hookdeck destination unarchive <destination-id>
902895# List all connections
903896hookdeck connection list
904897
905- # Filter by source
906- hookdeck connection list --source src_abc123
898+ # Filter by source ID
899+ hookdeck connection list --source-id src_abc123
907900
908- # Filter by destination
909- hookdeck connection list --destination dest_xyz789
901+ # Filter by destination ID
902+ hookdeck connection list --destination-id dest_xyz789
910903
911- # Filter by name pattern
912- hookdeck connection list --name " production-* "
904+ # Filter by connection name
905+ hookdeck connection list --name " production-connection "
913906
914907# Include disabled connections
915908hookdeck connection list --disabled
916909
917- # Include paused connections
918- hookdeck connection list --paused
910+ # Combine filters
911+ hookdeck connection list --source-id src_abc123 --disabled
919912
920- # Include archived connections
921- hookdeck connection list --archived
913+ # Limit results
914+ hookdeck connection list --limit 50
922915
923- # Combine filters
924- hookdeck connection list --source src_abc123 --disabled
916+ # Output as JSON
917+ hookdeck connection list --output json
925918```
926919
927920** Available Flags:**
928- - ` --source <id-or-name> ` - Filter by source ID or name
929- - ` --destination <id-or-name> ` - Filter by destination ID or name
930- - ` --name <pattern> ` - Filter by connection name
931- - ` --full-name <pattern> ` - Filter by full connection name (source > connection > destination)
932- - ` --disabled ` - Show only disabled connections
933- - ` --paused ` - Show only paused connections
934- - ` --archived ` - Show only archived connections
921+ - ` --name <string> ` - Filter by connection name
922+ - ` --source-id <string> ` - Filter by source ID
923+ - ` --destination-id <string> ` - Filter by destination ID
924+ - ` --disabled ` - Include disabled connections
925+ - ` --limit <int> ` - Limit number of results (default: 100)
935926- ` --output json ` - Output in JSON format
936927
937928### Get Connection
@@ -1236,16 +1227,11 @@ hookdeck connection enable conn_abc123
12361227# Pause/Unpause (queue events without forwarding)
12371228hookdeck connection pause conn_abc123
12381229hookdeck connection unpause conn_abc123
1239-
1240- # Archive/Unarchive (for inactive connections)
1241- hookdeck connection archive conn_abc123
1242- hookdeck connection unarchive conn_abc123
12431230```
12441231
12451232**State Differences:**
12461233- **Disabled**: Connection stops receiving events entirely
12471234- **Paused**: Connection queues events but doesn' t forward them
1248- - ** Archived** : Connection is hidden from main lists but can be restored
12491235
12501236# ## Implementation Notes
12511237
@@ -1254,7 +1240,7 @@ hookdeck connection unarchive conn_abc123
12541240- Inline resource creation with authentication
12551241- All 5 rule types (retry, filter, transform, delay, deduplicate)
12561242- Rate limiting configuration
1257- - Lifecycle management (enable, disable, pause, unpause, archive, unarchive )
1243+ - Lifecycle management (enable, disable, pause, unpause)
12581244- Idempotent upsert with dry-run support
12591245- 21 acceptance tests, all passing
12601246
0 commit comments