CLI Configuration: Config File, Flags, Output

Reference for the AhaSend CLI config file (~/.ahasend/config.yaml), profiles and global flags such as —profile, —output and —debug.

The AhaSend CLI stores configuration in ~/.ahasend/config.yaml and reads credentials from profiles or explicit command-line flags.

Before running the examples, log in with a full API key, use your verified sender domain, and replace YOUR_RESOURCE_ID with a resource UUID from your test account. Create any named template, recipient, attachment, or JSON files first. Shell examples use Bash; examples that read JSON with jq need jq installed. Sends use sandbox mode.

Configuration File

The configuration file is automatically created when you authenticate and contains your profiles and preferences:

default_profile: production
profiles:
  production:
    api_key: "YOUR_API_KEY"
    account_id: "YOUR_ACCOUNT_ID"
    api_url: "https://api.ahasend.com"
preferences:
  output_format: plain
  color_output: true

CI Credentials

The CLI reads no environment variables for credentials. It authenticates through ahasend auth login profiles, --profile, or --api-key with --account-id. In CI, store secrets as environment variables and pass them explicitly through flags:

ahasend --api-key "$AHASEND_API_KEY" --account-id "$AHASEND_ACCOUNT_ID" ping

Output Formats

Format	Use
plain	Default readable text
table	Table view
json	Structured output for scripts
csv	Export rows for a spreadsheet

The current CLI’s printer reads --output, whose default is plain; preferences.output_format does not override it. Pass the flag for each command. Credentials are plaintext in ~/.ahasend/config.yaml (Windows: %USERPROFILE%\.ahasend\config.yaml); protect this file.

Global Flags

Available for all commands:

# Authentication
--api-key string      # AhaSend API key (overrides profile)
--account-id string   # AhaSend Account ID (required with --api-key)
--profile string      # Profile to use (overrides default)

# Output
--output string       # Output format: table, json, plain, csv (default: plain)
--no-color            # Disable colored output

# Logging
--verbose             # Enable verbose output
--debug               # Enable debug mode

# Help
-h, --help            # Show help
-v, --version         # Show version

Next Steps

• Learn about authentication
• Explore available commands

Related Guides

• Install the CLI, CLI authentication, REST sending guide.
• SMTP settings, Node.js SDK, Go SDK.
• API authentication, Permission scopes, Domain setup.
• Sandbox behavior.