@aave/cli

@aave/cli

CLI to interact with AaveKit API

• Usage
• Commands

Usage

$ npm install -g @aave/cli
$ aave COMMAND
running command...
$ aave (--version)
@aave/cli/4.1.4 darwin-arm64 node-v25.9.0
$ aave --help [COMMAND]
USAGE
  $ aave COMMAND
...

Commands

• aave action borrow
• aave action repay
• aave action supply
• aave action withdraw
• aave hubs list
• aave reserve
• aave reserves list
• aave spokes list
• aave user balance
• aave user borrows
• aave user positions
• aave user summary
• aave user supplies

aave action borrow

Borrow ERC20 tokens from a reserve

USAGE
  $ aave action borrow --reserve-id <value> --amount <value> [--json] [-k <private-key>]

FLAGS
  -k, --private-key=<private-key>  Private key to sign transactions (overrides PRIVATE_KEY env var)
      --amount=<value>             (required) Amount of the token to borrow
      --reserve-id=<value>         (required) Reserve ID of the reserve to borrow from

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Borrow ERC20 tokens from a reserve

See code: src/commands/action/borrow.ts

aave action repay

Repay ERC20 debt to a reserve

USAGE
  $ aave action repay --reserve-id <value> --amount <value> [--json] [-k <private-key>]

FLAGS
  -k, --private-key=<private-key>  Private key to sign transactions (overrides PRIVATE_KEY env var)
      --amount=<value>             (required) Amount of the token to repay
      --reserve-id=<value>         (required) Reserve ID of the reserve to repay

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Repay ERC20 debt to a reserve

See code: src/commands/action/repay.ts

aave action supply

Supply ERC20 tokens to a reserve

USAGE
  $ aave action supply --reserve-id <value> --amount <value> [--json] [-k <private-key>] [--enable-collateral]

FLAGS
  -k, --private-key=<private-key>  Private key to sign transactions (overrides PRIVATE_KEY env var)
      --amount=<value>             (required) Amount of the token to supply
      --enable-collateral          If provided, the supplied position is enabled as collateral
      --reserve-id=<value>         (required) Reserve ID of the reserve to supply

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Supply ERC20 tokens to a reserve

See code: src/commands/action/supply.ts

aave action withdraw

Withdraw ERC20 tokens from a reserve

USAGE
  $ aave action withdraw --reserve-id <value> --amount <value> [--json] [-k <private-key>]

FLAGS
  -k, --private-key=<private-key>  Private key to sign transactions (overrides PRIVATE_KEY env var)
      --amount=<value>             (required) Amount of the token to withdraw
      --reserve-id=<value>         (required) Reserve ID of the reserve to withdraw from

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Withdraw ERC20 tokens from a reserve

See code: src/commands/action/withdraw.ts

aave hubs list

List Aave v4 liquidity hubs

USAGE
  $ aave hubs list [--json] [-c <chain-id>]

FLAGS
  -c, --chain=<chain-id>  The chain ID (e.g. 1, 137, 42161)

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  List Aave v4 liquidity hubs

See code: src/commands/hubs/list.ts

aave reserve

Show Aave v4 reserve details by reserve ID

USAGE
  $ aave reserve -i <value> [--json]

FLAGS
  -i, --id=<value>  (required) Reserve ID (e.g. SGVsbG8h…)

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Show Aave v4 reserve details by reserve ID

See code: src/commands/reserve.ts

aave reserves list

List Aave v4 reserves

USAGE
  $ aave reserves list [--json] [-s <spoke-id>] [-h <hub-id>] [--hub_address <evm-address> -c <chain-id>]

FLAGS
  -c, --chain_id=<chain-id>        The chain ID (e.g. 1, 137, 42161)
  -h, --hub_id=<hub-id>            The hub ID (e.g. SGVsbG8h…)
  -s, --spoke_id=<spoke-id>        The spoke ID (e.g. SGVsbG8h…)
      --hub_address=<evm-address>  The hub address (e.g. 0x123…)

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  List Aave v4 reserves

See code: src/commands/reserves/list.ts

aave spokes list

List Aave v4 spokes

USAGE
  $ aave spokes list [--json] [-h <hub-id>] [--hub_address <evm-address> -c <chain-id>]

FLAGS
  -c, --chain_id=<chain-id>        The chain ID (e.g. 1, 137, 42161)
  -h, --hub_id=<hub-id>            The hub ID (e.g. SGVsbG8h…)
      --hub_address=<evm-address>  The hub address (e.g. 0x123…)

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  List Aave v4 spokes

See code: src/commands/spokes/list.ts

aave user balance

List user token balances that can be used in Aave v4

USAGE
  $ aave user balance -c <chain-id> [--json] [--address <evm-address>]

FLAGS
  -c, --chain_id=<chain-id>    (required) Chain ID to query balances from
      --address=<evm-address>  User address (defaults to PRIVATE_KEY wallet address)

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  List user token balances that can be used in Aave v4

See code: src/commands/user/balance.ts

aave user borrows

List user borrows for a specific chain

USAGE
  $ aave user borrows -c <chain-id> [--json] [--address <evm-address>]

FLAGS
  -c, --chain_id=<chain-id>    (required) Chain ID to query borrows from
      --address=<evm-address>  User address (defaults to PRIVATE_KEY wallet address)

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  List user borrows for a specific chain

See code: src/commands/user/borrows.ts

aave user positions

List user positions across chains

USAGE
  $ aave user positions -c <chain-id> [--json] [--address <evm-address>]

FLAGS
  -c, --chain_id=<chain-id>    (required) Filter by chain ID
      --address=<evm-address>  User address (defaults to PRIVATE_KEY wallet address)

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  List user positions across chains

See code: src/commands/user/positions.ts

aave user summary

Show a user summary for a specific chain

USAGE
  $ aave user summary -c <chain-id> [--json] [--address <evm-address>]

FLAGS
  -c, --chain_id=<chain-id>    (required) Chain ID to query summary from
      --address=<evm-address>  User address (defaults to PRIVATE_KEY wallet address)

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Show a user summary for a specific chain

See code: src/commands/user/summary.ts

aave user supplies

List user supplies for a specific chain

USAGE
  $ aave user supplies -c <chain-id> [--json] [--address <evm-address>]

FLAGS
  -c, --chain_id=<chain-id>    (required) Chain ID to query supplies from
      --address=<evm-address>  User address (defaults to PRIVATE_KEY wallet address)

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  List user supplies for a specific chain

See code: src/commands/user/supplies.ts