Skip to content

Commit e946c72

Browse files
docs: document proxy and TLS configuration (OD-30)
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
1 parent 2d9d7ea commit e946c72

1 file changed

Lines changed: 31 additions & 0 deletions

File tree

README.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -262,3 +262,34 @@ export CODACY_CLI_V2_VERSION="1.0.0-main.133.3607792"
262262
Check the [releases](https://github.com/codacy/codacy-cli-v2/releases) page for all available versions.
263263

264264
---
265+
266+
## Proxy & TLS
267+
268+
The CLI honors standard proxy environment variables for all outbound HTTP(S):
269+
270+
- `HTTP_PROXY` / `HTTPS_PROXY` — proxy URL for plain/HTTPS requests
271+
- `NO_PROXY` — comma-separated hosts that bypass the proxy
272+
273+
### Corporate proxies with TLS interception
274+
275+
If your proxy presents its own (MITM) certificate, point the CLI at the proxy's CA bundle so TLS verification still passes:
276+
277+
```sh
278+
export SSL_CERT_FILE=/path/to/corporate-ca.pem
279+
```
280+
281+
`SSL_CERT_FILE` certificates are appended to the system trust store.
282+
283+
### Disabling TLS verification (last resort)
284+
285+
```sh
286+
export CODACY_CLI_INSECURE=1
287+
```
288+
289+
This disables certificate verification entirely and prints a warning. Prefer `SSL_CERT_FILE`. Insecure mode is never enabled by default.
290+
291+
### Testing proxy/TLS behavior
292+
293+
`integration-tests/proxy-tls/run.sh` runs the CLI through a real `mitmproxy` (`brew install mitmproxy`) against `app.codacy.com` and asserts the matrix above. Loop with `PROXY_TLS_LOOP=5 integration-tests/proxy-tls/run.sh`.
294+
295+
---

0 commit comments

Comments
 (0)