Piloterr

CLI

Install the Piloterr CLI SDK and make your first API call.

The official Piloterr command-line interface, with one command per endpoint.

Requirements

  • Node.js 20+

Install

npm install --global @piloterr/cli
piloterr --help
npx @piloterr/cli --help

Get your API key

Copy your API key from the Piloterr dashboard and set it in the PILOTERR_API_KEY environment variable, which the SDK reads by default. Keep it out of source control.

export PILOTERR_API_KEY="YOUR_API_KEY"
$env:PILOTERR_API_KEY = "YOUR_API_KEY"

Usage

piloterr amazon-product --query B09DFCB66S
piloterr amazon-product --help     # parameters of one command
piloterr endpoints                # every command and its HTTP path
piloterr endpoints search         # filter the list
piloterr website-screenshot --url https://example.com -o screenshot.png
echo '{"query": "B09DFCB66S"}' | piloterr amazon-product --params -
piloterr amazon-product --params params.json --compact
piloterr request get /v1/usage
piloterr request post /v1/some/new/endpoint --params body.json
piloterr amazon-product --query B09DFCB66S | jq .

Exit codes

  • 0: success
  • 1: API or network failure
  • 2: invalid usage, such as an unknown command, a missing API key or a missing parameter

On this page

RequirementsInstallGet your API keyUsageExit codesLinks