Skip to content

airswap/airswap-cli

main
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
bin
 
 
src
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

AirSwap CLI

Command Line Interface (CLI) for the AirSwap Network

Version License Downloads/week Discord Twitter Follow

Key Management

AirSwap CLI uses the native password manager of your system. On macOS, keys are managed by the Keychain, on Linux they are managed by the Secret Service API/libsecret, and on Windows they are managed by Credential Vault.

Quick Start

Install the CLI globally

$ yarn global add airswap

Create a new account to use for the CLI (recommended)

$ airswap account:generate

Import the newly generated or an existing private key

$ airswap account:import

Explore the Network

Set the active chain (ChainIds)

$ airswap chain

Get URLs for active servers

$ airswap registry:get

Get a quote from a specific peer

$ airswap rfq:get

Get the best quote from all peers

$ airswap rfq:best

Balance Management

Get balances for known tokens

$ airswap balances

Transfer a balance to another account

$ airswap token:transfer

Deposit a native balance (e.g. ETH) into wrapped (e.g. WETH)

$ airswap wrapped:deposit

Withdraw a native balance from wrapped

$ airswap wrapped:withdraw

All Commands

airswap account:delete

delete the current ethereum account

USAGE
  $ airswap account:delete

DESCRIPTION
  delete the current ethereum account

See code: src/commands/account/delete.ts

airswap account:export

export the current ethereum account

USAGE
  $ airswap account:export

DESCRIPTION
  export the current ethereum account

See code: src/commands/account/export.ts

airswap account:generate

generate a new ethereum account

USAGE
  $ airswap account:generate

DESCRIPTION
  generate a new ethereum account

See code: src/commands/account/generate.ts

airswap account:import

import an ethereum account

USAGE
  $ airswap account:import

DESCRIPTION
  import an ethereum account

See code: src/commands/account/import.ts

airswap balances

display token balances

USAGE
  $ airswap balances

DESCRIPTION
  display token balances

See code: src/commands/balances.ts

airswap chain

set the active ethereum chain

USAGE
  $ airswap chain

DESCRIPTION
  set the active ethereum chain

See code: src/commands/chain.ts

airswap gas

set gas price for transactions

USAGE
  $ airswap gas

DESCRIPTION
  set gas price for transactions

See code: src/commands/gas.ts

airswap help [COMMANDS]

Display help for airswap.

USAGE
  $ airswap help [COMMANDS] [-n]

ARGUMENTS
  COMMANDS  Command to show help for.

FLAGS
  -n, --nested-commands  Include all nested commands in the output.

DESCRIPTION
  Display help for airswap.

See code: @oclif/plugin-help

airswap ip

display local network addresses

USAGE
  $ airswap ip

DESCRIPTION
  display local network addresses

See code: src/commands/ip.ts

airswap metadata:add

add token to local metadata

USAGE
  $ airswap metadata:add

DESCRIPTION
  add token to local metadata

See code: src/commands/metadata/add.ts

airswap metadata:delete

delete token from local metadata

USAGE
  $ airswap metadata:delete

DESCRIPTION
  delete token from local metadata

See code: src/commands/metadata/delete.ts

airswap metadata:lookup

lookup token in local metadata

USAGE
  $ airswap metadata:lookup

DESCRIPTION
  lookup token in local metadata

See code: src/commands/metadata/lookup.ts

airswap metadata:update

update local metadata from remote sources

USAGE
  $ airswap metadata:update

DESCRIPTION
  update local metadata from remote sources

See code: src/commands/metadata/update.ts

airswap registry:add

add supported tokens to the registry

USAGE
  $ airswap registry:add

DESCRIPTION
  add supported tokens to the registry

See code: src/commands/registry/add.ts

airswap registry:enable

enable staking on the registry

USAGE
  $ airswap registry:enable

DESCRIPTION
  enable staking on the registry

See code: src/commands/registry/enable.ts

airswap registry:get

get urls from the registry

USAGE
  $ airswap registry:get

DESCRIPTION
  get urls from the registry

See code: src/commands/registry/get.ts

airswap registry:list

list supported tokens from registry

USAGE
  $ airswap registry:list

DESCRIPTION
  list supported tokens from registry

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

airswap registry:remove

remove supported tokens from the registry

USAGE
  $ airswap registry:remove

DESCRIPTION
  remove supported tokens from the registry

See code: src/commands/registry/remove.ts

airswap registry:url

set server url on the registry

USAGE
  $ airswap registry:url

DESCRIPTION
  set server url on the registry

See code: src/commands/registry/url.ts

airswap rfq:best

get the best available order

USAGE
  $ airswap rfq:best

DESCRIPTION
  get the best available order

See code: src/commands/rfq/best.ts

airswap rfq:get

get an order from a peer

USAGE
  $ airswap rfq:get

DESCRIPTION
  get an order from a peer

See code: src/commands/rfq/get.ts

airswap stream:open

stream quotes for a swap

USAGE
  $ airswap stream:open

DESCRIPTION
  stream quotes for a swap

See code: src/commands/stream/open.ts

airswap token:approve

approve a token for trading

USAGE
  $ airswap token:approve

DESCRIPTION
  approve a token for trading

See code: src/commands/token/approve.ts

airswap token:revoke

revoke a token approval

USAGE
  $ airswap token:revoke

DESCRIPTION
  revoke a token approval

See code: src/commands/token/revoke.ts

airswap token:transfer

transfer tokens to another account

USAGE
  $ airswap token:transfer

DESCRIPTION
  transfer tokens to another account

See code: src/commands/token/transfer.ts

airswap wrapped:deposit

deposit eth to weth

USAGE
  $ airswap wrapped:deposit

DESCRIPTION
  deposit eth to weth

See code: src/commands/wrapped/deposit.ts

airswap wrapped:withdraw

withdraw eth from weth

USAGE
  $ airswap wrapped:withdraw

DESCRIPTION
  withdraw eth from weth

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