Skip to content

Commit d297f61

Browse files
docs(connectivity-check): align README with implementation (#404)
1 parent 903a267 commit d297f61

File tree

1 file changed

+18
-8
lines changed
  • pkg/local_workflows/connectivity_check_extension

1 file changed

+18
-8
lines changed

pkg/local_workflows/connectivity_check_extension/README.md

Lines changed: 18 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,15 @@ A Go-based extension for the Snyk CLI that performs comprehensive network connec
1111
- **Actionable Diagnostics**: Provides specific recommendations based on connectivity issues
1212
- **Integration Ready**: Built as a workflow extension for the Snyk CLI using go-application-framework
1313

14+
## Workflow ID and Invocation
15+
16+
- Workflow ID: `tools.connectivity-check`
17+
- Output MIME types:
18+
- Human-readable: `text/plain`
19+
- JSON: `application/json`
20+
21+
Flags (see below) are provided via the framework configuration/flagset.
22+
1423
### Environment Variables
1524

1625
The tool respects standard proxy environment variables:
@@ -28,9 +37,9 @@ The tool uses Snyk authentication from the go-application-framework configuratio
2837
- OAuth tokens
2938
- Bearer tokens
3039

31-
When authenticated, the tool will display your organizations with their IDs. The default organization is highlighted with a `[DEFAULT]` marker.
40+
When authenticated, the tool will display your organizations with their IDs. The default organization is indicated with `Default = Yes` and the entire line is highlighted in success color in colorized output.
3241

33-
### Command Line Options
42+
### Flags
3443

3544
- `--json` - Output results in JSON format
3645
- `--no-color` - Disable colored output
@@ -95,15 +104,16 @@ b2c3d4e5-f6a7-8901-bcde-f23456789012 e5f6a7b8-c901-def2-3456-7890abcdef12 Anot
95104
### JSON Output
96105

97106
```bash
98-
snyk connectivity-check --json
107+
snyk tools connectivity-check --json --experimental
99108
```
100109

101110
```json
102111
{
103112
"proxyConfig": {
104113
"detected": false,
105114
"url": "",
106-
"variable": ""
115+
"variable": "",
116+
"noProxy": ""
107117
},
108118
"hostResults": [
109119
{
@@ -148,13 +158,13 @@ If you see "PROXY AUTH REQUIRED", the tool has detected your proxy but needs aut
148158
- For other proxy auth types: Configure proxy credentials in your proxy URL
149159

150160
#### DNS Errors
151-
If you see "DNS_ERROR" for multiple hosts:
161+
If you see "DNS ERROR" for multiple hosts:
152162
- Check your DNS configuration
153163
- Verify you can resolve external domains
154164
- Check if you need to use a corporate DNS server
155165

156166
#### TLS/SSL Errors
157-
If you see "TLS/SSL_ERROR":
167+
If you see "TLS/SSL ERROR":
158168
- You may need to configure custom CA certificates
159169
- Set `NODE_EXTRA_CA_CERTS` to point to your CA bundle
160170
- Ensure your proxy (if any) isn't intercepting SSL
@@ -170,8 +180,8 @@ If authenticated but no organizations shown:
170180
- **OK**: Full connectivity verified
171181
- **REACHABLE**: Host is reachable but returned unexpected status
172182
- **BLOCKED**: Connection refused or blocked
173-
- **DNS_ERROR**: Cannot resolve hostname
174-
- **TLS/SSL_ERROR**: Certificate or TLS handshake issues
183+
- **DNS ERROR**: Cannot resolve hostname
184+
- **TLS/SSL ERROR**: Certificate or TLS handshake issues
175185
- **TIMEOUT**: Connection timed out
176186
- **PROXY AUTH REQUIRED (SUPPORTED)**: Proxy needs auth, type is supported
177187
- **PROXY AUTH REQUIRED (UNSUPPORTED)**: Proxy needs auth, type not supported

0 commit comments

Comments
 (0)