Airwallex CLI

The Airwallex CLI lets you work with your Airwallex account directly from a command line. It exposes a broad slice of the Airwallex API as terminal commands, so you can read and write production resources, script repeatable tasks, and wire Airwallex into automated systems — without writing an HTTP client.

Use the CLI when you want to:

• Explore the API interactively — discover endpoints, preview requests, and inspect schemas before you commit to a full integration.
• Power AI coding agents — let agents that can run terminal commands (for example, Claude Code, Cursor, and Codex) operate against your account. This is also the foundation of Airwallex AgentOS.

The CLI is compatible with macOS and Linux.

Who can install

As the Airwallex CLI requires OAuth authorization, only users with the Owner, Admin, or Finance Admin role on the Airwallex account can authorize the CLI. Other roles will not be able to complete the OAuth authorization flow. Refer to User roles that can grant OAuth consent for more details.

Before you begin

• macOS or Linux.
• curl installed and available in your shell.
• Write access to ~/.local/bin. If you previously ran an installation command with sudo, restore ownership before continuing — see Troubleshooting.

Install

Download and install the CLI. The script auto-detects your OS and architecture and installs to ~/.local/bin/airwallex:

1curl -fsSL https://static.airwallex.com/developer-tools/airwallex-cli/install.sh | sh

Authenticate

After installation, sign in to your Airwallex account.

Log in to sandbox

By default, the CLI connects to the sandbox environment . Complete the authentication and authorization flow in the browser that opens:

1airwallex auth login

Log in to production

To connect to your production Airwallex account, pass the --prod flag:

1airwallex auth login --prod

Log in with scoped access

You can limit the CLI access to specific API scopes. See OAuth scopes for the full list of available scopes.

1airwallex auth login --prod --scope=balance:read

Check authentication status

Verify which environment you are connected to and whether you are signed in:

1airwallex auth whoami

Send feedback

Open your default email client to send feedback to the Airwallex team:

1airwallex feedback --message "Can you please add support for listing <resource> from my organization?"

Agent usage

Discover the CLI surface

List every available command and sub-command:

1airwallex --tree

Show only the commands under a specific resource:

1airwallex --tree invoices

Preview API requests

Review the API request corresponding to a resource command before executing it:

1airwallex --dry-run products list

Compact JSON output

Return compact JSON for efficient consumption by scripts or agents:

1airwallex --compact meters list --page-size=1

Write actions with confirmation

Write actions require confirmation in interactive mode by default. Override when you know what you are doing — for example, in a non-interactive script or pipeline:

1echo '{
2  "name": "Demo product — ceramic coffee mug (12 oz)",
3  "description": "Example catalog item for testing the CLI. Not a real product or offer.",
4  "request_id": "ceramic-coffee-mug-245abe6"
5}' | airwallex --confirm products create --data-stdin

Discover API schemas

View the schema of the API endpoint invoked by a given resource command:

1airwallex products update --api-schema-only

For the full command reference, run airwallex -h.

Use the CLI with AI agents

AI coding agents that can run terminal commands — for example, Claude Code, Cursor, and Codex — can call the CLI on your behalf to read and act on your account. Download Skills from the Airwallex AgentOS plugin for pre-built workflows on Airwallex.

When agents use the CLI, the safety guardrails still apply: money-out actions (transfers, FX conversions, payouts) are not initiated on your behalf by default, and write actions require confirmation unless --confirm is passed.

Deauthorize and uninstall

Sign out of the CLI

To sign out of the Airwallex CLI and remove the credentials stored on your machine, run:

1airwallex auth logout

This command clears the locally stored OAuth tokens for your current Airwallex CLI session. It does not revoke or invalidate the token itself.

A few things to note:

• The CLI stores only one set of credentials at a time.
• Running login again replaces the previous saved credentials.
• Running logout only removes credentials from your local environment.

Revoke the OAuth token

If you want to fully revoke the OAuth token used by the CLI, do that in the Airwallex web app instead:

Manage your connections in the Airwallex web app

Use the CLI command when you want to sign out locally. Use the web app when you want to revoke the token completely.

Uninstall the CLI

After logging out, remove the binary:

1rm ~/.local/bin/airwallex

Troubleshooting

Cannot write to ~/.local/bin

Symptom: The installer fails because ~/.local is not writable.

Cause: This happens when $HOME is not set in your shell environment (causing the install path to resolve incorrectly), or when ~/.local is owned by root — usually from a previous sudo command.

Fix: Restore ownership of the directory, then reinstall the CLI:

1sudo chown -R $(whoami) ~/.local

Telemetry

Telemetry is enabled by default. You can disable telemetry either globally using the DISABLE_TELEMETRY environment variable or for a specific command execution using the --no-telemetry global CLI option.

When enabled, the CLI collects basic device information (OS, architecture) and usage metrics related to command execution (command name, error code, latency, exit code).

See also

• Airwallex AgentOS — the production-grade agent toolkit built on the CLI, with pre-built skills and one-step plugins.
• OAuth scopes — limit CLI access to specific API operations.
• API reference API — the full Airwallex API the CLI is built on.