InboxSpecDocumentation

Developer tools

Client installation

Install the reviewed private SDK and CLI release archives.

Set up a client

REST works directly with your project key and the API address below. SDK and CLI archives are available in the private Clients 0.1.0 release. npm registry publication is pending. The SDK supports Node.js 24+ or Bun 1.4+; the CLI needs Bun 1.4+ on Linux or macOS.

Example
export INBOXSPEC_API_URL='https://api.inboxspec.com'
# Set INBOXSPEC_API_KEY to your saved project key in this terminal.

Install a reviewed release

Download all archives and SHA256SUMS from the private release. Repository access is required; contact your InboxSpec owner if it is unavailable. REST works without these packages.

Example
sha256sum -c SHA256SUMS
# macOS: shasum -a 256 -c SHA256SUMS
npm install ./inboxspec-sdk-0.1.0.tgz
npm install --global ./inboxspec-cli-0.1.0.tgz
inboxspec --help

These npm commands install local archives. Pin the reviewed version and checksums in CI. In an installed SDK example, import InboxSpec from @inboxspec/sdk.