---
title: Adi Shipping CLI
description: Install and use the official Adi Shipping command-line client for API discovery and shipment tracking.
canonical: https://adi-shipping.com/developers/cli/
last-updated: 2026-10-10
---

# Adi Shipping CLI

The official `adi-shipping` command-line client provides scriptable access to the public API discovery document and read-only ZIM shipment tracking operation. It does not create bookings, request quotes, or contain carrier credentials.

## Install from the official site

Node.js 18 or newer is required.

```sh
npm install --global https://adi-shipping.com/cli/adi-shipping-cli-1.0.0.tgz
```

The same executable is available for inspection at [adi-shipping.mjs](https://adi-shipping.com/cli/adi-shipping.mjs). A public npm registry release is planned; until it is published, the official site archive is the authoritative distribution.

## Commands

```sh
adi-shipping api
adi-shipping track YOUR_ZIM_REFERENCE
adi-shipping --help
adi-shipping --version
```

`adi-shipping api` prints the API discovery document. `adi-shipping track` accepts a known ZIM booking, bill of lading, or container reference and prints JSON. Failures are emitted to standard error as RFC 9457-compatible problem documents and use a non-zero exit code.

## Automation and privacy

Use only a shipment reference the customer is authorized to access. Do not enumerate references, store results longer than necessary, or treat carrier estimates as guaranteed. The API rate-limit headers apply equally to CLI requests.

## Related resources

- [Developer guide](https://adi-shipping.com/developers/)
- [OpenAPI 3.1 contract](https://adi-shipping.com/openapi.json)
- [Error model](https://adi-shipping.com/developers/errors/)
- [Versioning and deprecation policy](https://adi-shipping.com/developers/versioning/)