Autom

CLI

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

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

Requirements

  • Node.js 20+

Install

npm install --global @automdev/cli
autom --help
npx @automdev/cli --help

Get your API key

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

export AUTOM_API_KEY="YOUR_API_KEY"
$env:AUTOM_API_KEY = "YOUR_API_KEY"

Usage

autom google-search --query 'web scraping api'
autom google-search --help     # parameters of one command
autom endpoints                # every command and its HTTP path
autom endpoints search         # filter the list
echo '{"query": "web scraping api"}' | autom google-search --params -
autom google-search --params params.json --compact
autom request get /v1/usage
autom request post /v1/some/new/endpoint --params body.json
autom google-search --query 'web scraping api' | 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