# @npmcli/agent

> the http/https agent used by the npm cli

Latest version **5.0.2** (published 2026-06-19) · ISC license · 0 weekly downloads

## Install

```sh
npm install @npmcli/agent
pnpm add @npmcli/agent
yarn add @npmcli/agent
bun add @npmcli/agent
```

## Health

**Score 60/100 (C)** — status: active.

Positive: no vulnerabilities; has provenance; recently updated; high maintenance score.

Warnings: low downloads; no types; no esm support.

## Facts

| | |
|---|---|
| Version | 5.0.2 |
| Published | 2026-06-19 |
| First published | 2022-12-08 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Node | ^22.22.2 \|\| ^24.15.0 \|\| >=26.0.0 |
| Dependencies | 5 |
| Unpacked size | 19.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Provenance | attested (GitHub Actions) |
| GitHub stars | 11 |
| Author | GitHub Inc. |
| Maintainers | saquibkhan, npm-cli-ops, reggi, owlstronaut |

## Links

- npm: https://www.npmjs.com/package/@npmcli/agent
- Repository: https://github.com/npm/agent
- Homepage: https://github.com/npm/agent#readme
- Issues: https://github.com/npm/agent/issues
- npm.io page: https://npm.io/package/@npmcli/agent

## Dependencies (5)

- [lru-cache](https://npm.io/package/lru-cache.md) ^11.2.1
- [agent-base](https://npm.io/package/agent-base.md) ^9.0.0
- [http-proxy-agent](https://npm.io/package/http-proxy-agent.md) ^9.0.0
- [https-proxy-agent](https://npm.io/package/https-proxy-agent.md) ^9.0.0
- [socks-proxy-agent](https://npm.io/package/socks-proxy-agent.md) ^10.0.0

## Recent versions

- 5.0.2 (latest) — 2026-06-19
- 4.0.2 — 2026-05-27
- 5.0.1 — 2026-05-26
- 5.0.0 — 2026-05-07
- 4.0.0 — 2025-09-18
- 3.0.0 — 2024-08-26
- 2.2.2 — 2024-04-01
- 2.2.1 — 2024-02-05
- 2.2.0 — 2023-10-02
- 2.1.1 — 2023-09-08
- 2.1.0 — 2023-08-30
- 2.0.0 — 2023-08-15
- 1.1.0 — 2023-05-16
- 1.0.0 — 2022-12-08

## README

## @npmcli/agent

A pair of Agent implementations for nodejs that provide consistent keep-alives, granular timeouts, dns caching, and proxy support.

### Usage

```js
const { getAgent, HttpAgent } = require('@npmcli/agent')
const fetch = require('minipass-fetch')

const main = async () => {
    // if you know what agent you need, you can create one directly
    const agent = new HttpAgent(agentOptions)
    // or you can use the getAgent helper, it will determine and create an Agent
    // instance for you as well as reuse that agent for new requests as appropriate
    const agent = getAgent('https://registry.npmjs.org/npm', agentOptions)
    // minipass-fetch is just an example, this will work for any http client that
    // supports node's Agents
    const res = await fetch('https://registry.npmjs.org/npm', { agent })
}

main()
```

### Options

All options supported by the node Agent implementations are supported here, see [the docs](https://nodejs.org/api/http.html#new-agentoptions) for those.

Options that have been added by this module include:

- `family`: what tcp family to use, can be `4` for IPv4, `6` for IPv6 or `0` for both.
- `proxy`: a URL to a supported proxy, currently supports `HTTP CONNECT` based http/https proxies as well as socks4 and 5.
- `dns`: configuration for the built-in dns cache
    - `ttl`: how long (in milliseconds) to keep cached dns entries, defaults to `5 * 60 * 100 (5 minutes)`
    - `lookup`: optional function to override how dns lookups are performed, defaults to `require('dns').lookup`
- `timeouts`: a set of granular timeouts, all default to `0`
    - `connection`: time between initiating connection and actually connecting
    - `idle`: time between data packets (if a top level `timeout` is provided, it will be copied here)
    - `response`: time between sending a request and receiving a response
    - `transfer`: time between starting to receive a request and consuming the response fully

---
_Source: https://npm.io/package/@npmcli/agent · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._