CLI - Hostreach

The Hostreach CLI (hostreach) is included in the @hostreach/cli npm package. Every public API endpoint is available as a subcommand, auto-generated from the OpenAPI spec and always in sync.

Install

npm install -g @hostreach/cli

Or run without installing:

npx -p @hostreach/cli hostreach --help

Authenticate

hostreach auth login      # interactive — saves key + base URL to ~/.config/hostreach/
hostreach auth status     # show current auth
hostreach auth logout     # remove stored credentials

You can also pass credentials inline or via environment variable:

# Flag (highest priority)
hostreach campaigns list --api-key hr_live_your_key_here

# Environment variable
export HOSTREACH_API_KEY=hr_live_your_key_here
hostreach campaigns list

Usage

hostreach <resource> <action> [--flags]

Discover endpoints

hostreach list                      # all resources
hostreach list campaigns            # actions for campaigns
hostreach campaigns list --help     # parameters for one action

Examples

# Identity
hostreach me list

# Platforms
hostreach platforms list
hostreach platforms locations --platform idealista --q "Valencia"

# Extractions
hostreach extractions create --platform idealista --filters '{"operation":"rent","location":"..."}' --max-results 50
hostreach extractions get --id <id>        # poll until status=COMPLETED
hostreach extractions leads --id <id>

# Campaigns
hostreach campaigns list
hostreach campaigns create --name "Valencia Q3" --platform idealista
hostreach campaigns execute --id <id>

# Leads
hostreach leads list --status PENDING --limit 20
hostreach leads update --id <id> --status CONTACTED

# Messaging
hostreach messaging conversations --limit 20
hostreach messaging send --lead-id <id> --message "Hola!"

Output formats

Flag	Output
(default)	Compact JSON
`--pretty`	Pretty-printed JSON
`--format table`	ASCII table
`--format csv`	CSV (stdout)
`--format markdown`	Markdown table
`--output <path>`	Save to file; prints file path
`--clean`	Strip nulls and empty values

hostreach leads list --format csv > leads.csv
hostreach campaigns list --format markdown
hostreach leads list --output ./leads.json

All status messages go to stderr; data goes to stdout — safe for piping.

Refresh OpenAPI cache

hostreach campaigns list --refresh    # force re-fetch of OpenAPI spec

​Install

​Authenticate

​Usage

​Discover endpoints

​Examples

​Output formats

​Refresh OpenAPI cache