Environment Variables

Required

SHIPI_API_KEY

Your shipi API key. Required for all operations.

export SHIPI_API_KEY=your-api-key

Get your API key at the dashboard.

Optional

SHIPI_BASE_URL

Override the API base URL. Useful for self-hosted instances.

export SHIPI_BASE_URL=https://api.yourcompany.com

SHIPI_TIMEOUT

Request timeout in milliseconds. Default: 30000 (30 seconds).

export SHIPI_TIMEOUT=60000

SHIPI_DEBUG

Enable debug logging.

export SHIPI_DEBUG=true

Using .env files

Shipi automatically loads .env files in your project root.

SHIPI_API_KEY=your-api-key

CI/CD environments

GitHub Actions

env:
  SHIPI_API_KEY: ${{ secrets.SHIPI_API_KEY }}

GitLab CI

Add SHIPI_API_KEY as a CI/CD variable in Settings → CI/CD → Variables.

variables:
  SHIPI_API_KEY: $SHIPI_API_KEY

Other CI systems

Set SHIPI_API_KEY as a secret environment variable in your CI configuration.