@aave/cli
CLI to interact with AaveKit API
Usage
$ npm install -g @aave/cli
$ aave COMMAND
running command...
$ aave (--version)
@aave/cli/4.2.0 linux-x64 node-v22.22.2
$ aave --help [COMMAND]
USAGE
$ aave COMMAND
...
Commands
aave action borrowaave action claim-rewardsaave action repayaave action supplyaave action swap tokenaave action withdrawaave hubs listaave reserveaave reserves holdersaave reserves listaave spokes listaave user balanceaave user borrowsaave user positionsaave user rewardsaave user summaryaave 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 claim-rewards
Claim rewards for the current wallet
USAGE
$ aave action claim-rewards -c <chain-id> [--json] [--ids <value>] [-k <private-key>]
FLAGS
-c, --chain_id=<chain-id> (required) Chain ID to claim rewards on
-k, --private-key=<private-key> Private key to sign transactions (overrides PRIVATE_KEY env var)
--ids=<value> Comma-separated reward IDs to claim (defaults to all claimable rewards for the wallet
on this chain)
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Claim rewards for the current wallet
See code: src/commands/action/claim-rewards.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 swap token
Swap one token for another token using market mode
USAGE
$ aave action swap token -c <chain-id> --sell-token <value> --buy-token <value> --amount <value> [--json] [--kind
sell|buy] [--quote-only] [--address <evm-address>] [-k <private-key>]
FLAGS
-c, --chain=<chain-id> (required) Chain ID where the token swap will be executed
-k, --private-key=<private-key> Private key to sign transactions (overrides PRIVATE_KEY env var)
--address=<evm-address> User address for quote generation
--amount=<value> (required) Amount to swap
--buy-token=<value> (required) Token address to buy
--kind=<option> [default: sell] Swap amount interpretation
<options: sell|buy>
--quote-only Only fetch and display quote
--sell-token=<value> (required) Token address to sell
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Swap one token for another token using market mode
See code: src/commands/action/swap/token.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 holders
List top holders for a reserve
USAGE
$ aave reserves holders -i <value> [--json] [-f SUPPLIED|BORROWED]
FLAGS
-f, --filter=<option> [default: SUPPLIED] Filter by SUPPLIED or BORROWED holders
<options: SUPPLIED|BORROWED>
-i, --id=<value> (required) Reserve ID (e.g. SGVsbG8h…)
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
List top holders for a reserve
See code: src/commands/reserves/holders.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 rewards
List claimable rewards for a user on a specific chain
USAGE
$ aave user rewards -c <chain-id> [--json] [--address <evm-address>]
FLAGS
-c, --chain_id=<chain-id> (required) Chain ID to query rewards from
--address=<evm-address> User address (defaults to PRIVATE_KEY wallet address)
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
List claimable rewards for a user on a specific chain
See code: src/commands/user/rewards.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