Skip to main content

​
What is ampctl?

ampctl is the administration CLI for Amp engine operators. It provides a comprehensive command-line interface for managing all aspects of Amp infrastructure through the Admin API. This is the operator’s swiss-army knife for Amp administration.

​
Administrative CLI Tool

ampctl is designed for DevOps engineers and administrators who need to:
  • Manage dataset lifecycles (register, deploy, list)
  • Control extraction jobs (monitor, stop, delete)
  • Monitor worker nodes and check health status
  • Manage blockchain data providers
  • Query storage locations and file metadata
  • Validate SQL queries and schemas

​
Connection to Admin API

ampctl communicates with the Amp controller’s Admin API on port 1610: 
ampctl → Admin API (port 1610) → Controller

​
Configuration

The Admin API URL can be configured in three ways: Default behavior: 
# Uses default: http://localhost:1610
ampctl worker list
Via command-line flag: 
# Connect to production controller
ampctl --admin-url http://production:1610 worker list

# Connect to custom port
ampctl --admin-url http://localhost:8080 datasets list
Via environment variable: 
# Set for all commands in session
export AMP_ADMIN_URL="http://production:1610"
ampctl worker list
ampctl datasets list
Configuration precedence:
  1. --admin-url flag (highest priority)
  2. AMP_ADMIN_URL environment variable
  3. Default: http://localhost:1610

​
Common Flags

All ampctl commands support these global flags:
​
--admin-url
string
default:"http://localhost:1610"
Admin API URL. Can also be set via AMP_ADMIN_URL environment variable.
​
--auth-token
string
Bearer authentication token for secured Admin API endpoints. Can also be set via AMP_AUTH_TOKEN environment variable.
​
--json
boolean
default:"false"
Output results in JSON format for scripting and automation.

​
Authentication

Optional authentication token for secured Admin API endpoints: 
# Via flag
ampctl --auth-token <token> worker list

# Via environment variable
export AMP_AUTH_TOKEN="<token>"
ampctl worker list

​
JSON Output

All commands support JSON output for scripting and automation: 
# Human-readable output (default)
ampctl dataset list

# JSON output
ampctl dataset list --json

​
Command Groups

ampctl provides the following command groups:
  • datasets - Dataset lifecycle management (register, deploy, list)
  • jobs - Job control and monitoring (list, stop, progress)
  • workers - Worker node monitoring (list, inspect, health)
  • providers - Provider configuration (register, list, delete)

​
Getting Help

View all available commands: 
ampctl --help
View help for a specific command: 
ampctl datasets --help
ampctl jobs list --help

Build docs developers (and LLMs) love

Get started for freeTalk to us