Command Line Interface (CLI) for the AirSwap Network
- About → https://about.airswap.io/
- Website → https://www.airswap.io/
- Blog → https://blog.airswap.io/
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.
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
Set the active chain
$ airswap chain
airswap account:delete
airswap account:export
airswap account:generate
airswap account:import
airswap approve
airswap balances
airswap best
airswap chain
airswap delegate:authorize
airswap delegate:revoke
airswap delegate:set
airswap delegate:swap
airswap delegate:unset
airswap gas
airswap help [COMMANDS]
airswap inspect
airswap ip
airswap metadata:add
airswap metadata:delete
airswap metadata:lookup
airswap metadata:update
airswap order
airswap protocols:add
airswap protocols:list
airswap protocols:remove
airswap registry:approve
airswap registry:eject
airswap registry:list
airswap registry:revoke
airswap registry:status
airswap registry:url
airswap revoke
airswap stream
airswap tokens:add
airswap tokens:list
airswap tokens:remove
airswap transfer
airswap wrapped:deposit
airswap wrapped:withdraw
delete the current ethereum account
USAGE
$ airswap account:delete
DESCRIPTION
delete the current ethereum account
See code: src/commands/account/delete.ts
export the current ethereum account
USAGE
$ airswap account:export
DESCRIPTION
export the current ethereum account
See code: src/commands/account/export.ts
generate a new ethereum account
USAGE
$ airswap account:generate
DESCRIPTION
generate a new ethereum account
See code: src/commands/account/generate.ts
import an ethereum account
USAGE
$ airswap account:import
DESCRIPTION
import an ethereum account
See code: src/commands/account/import.ts
approve a token for trading
USAGE
$ airswap approve
DESCRIPTION
approve a token for trading
See code: src/commands/approve.ts
display token balances
USAGE
$ airswap balances
DESCRIPTION
display token balances
See code: src/commands/balances.ts
compare order pricing from servers
USAGE
$ airswap best
DESCRIPTION
compare order pricing from servers
See code: src/commands/best.ts
set the active chain
USAGE
$ airswap chain
DESCRIPTION
set the active chain
See code: src/commands/chain.ts
authorize a rule manager
USAGE
$ airswap delegate:authorize
DESCRIPTION
authorize a rule manager
See code: src/commands/delegate/authorize.ts
revoke a rule manager
USAGE
$ airswap delegate:revoke
DESCRIPTION
revoke a rule manager
See code: src/commands/delegate/revoke.ts
set a delegate rule
USAGE
$ airswap delegate:set
DESCRIPTION
set a delegate rule
See code: src/commands/delegate/set.ts
swap with the delegate
USAGE
$ airswap delegate:swap
DESCRIPTION
swap with the delegate
See code: src/commands/delegate/swap.ts
unset a delegate rule
USAGE
$ airswap delegate:unset
DESCRIPTION
unset a delegate rule
See code: src/commands/delegate/unset.ts
set gas price for transactions
USAGE
$ airswap gas
DESCRIPTION
set gas price for transactions
See code: src/commands/gas.ts
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
inspect protocols for a server
USAGE
$ airswap inspect
DESCRIPTION
inspect protocols for a server
See code: src/commands/inspect.ts
display local network addresses
USAGE
$ airswap ip
DESCRIPTION
display local network addresses
See code: src/commands/ip.ts
add token to local metadata
USAGE
$ airswap metadata:add
DESCRIPTION
add token to local metadata
See code: src/commands/metadata/add.ts
delete token from local metadata
USAGE
$ airswap metadata:delete
DESCRIPTION
delete token from local metadata
See code: src/commands/metadata/delete.ts
lookup token in local metadata
USAGE
$ airswap metadata:lookup
DESCRIPTION
lookup token in local metadata
See code: src/commands/metadata/lookup.ts
update local metadata from remote sources
USAGE
$ airswap metadata:update
DESCRIPTION
update local metadata from remote sources
See code: src/commands/metadata/update.ts
get an order from a server
USAGE
$ airswap order
DESCRIPTION
get an order from a server
See code: src/commands/order.ts
add supported protocols to the registry
USAGE
$ airswap protocols:add
DESCRIPTION
add supported protocols to the registry
See code: src/commands/protocols/add.ts
list activated protocols
USAGE
$ airswap protocols:list
DESCRIPTION
list activated protocols
See code: src/commands/protocols/list.ts
remove supported protocols from the registry
USAGE
$ airswap protocols:remove
DESCRIPTION
remove supported protocols from the registry
See code: src/commands/protocols/remove.ts
enable staking on the registry
USAGE
$ airswap registry:approve
DESCRIPTION
enable staking on the registry
See code: src/commands/registry/approve.ts
remove url, protocols, and tokens from registry
USAGE
$ airswap registry:eject
DESCRIPTION
remove url, protocols, and tokens from registry
See code: src/commands/registry/eject.ts
get urls from the registry
USAGE
$ airswap registry:list
DESCRIPTION
get urls from the registry
See code: src/commands/registry/list.ts
disable staking on the registry
USAGE
$ airswap registry:revoke
DESCRIPTION
disable staking on the registry
See code: src/commands/registry/revoke.ts
check status of url, protocols, and tokens on registry
USAGE
$ airswap registry:status
DESCRIPTION
check status of url, protocols, and tokens on registry
See code: src/commands/registry/status.ts
set server url on the registry
USAGE
$ airswap registry:url
DESCRIPTION
set server url on the registry
See code: src/commands/registry/url.ts
revoke a token approval
USAGE
$ airswap revoke
DESCRIPTION
revoke a token approval
See code: src/commands/revoke.ts
stream quotes for a swap
USAGE
$ airswap stream
DESCRIPTION
stream quotes for a swap
See code: src/commands/stream.ts
add supported tokens to the registry
USAGE
$ airswap tokens:add
DESCRIPTION
add supported tokens to the registry
See code: src/commands/tokens/add.ts
list activated tokens
USAGE
$ airswap tokens:list
DESCRIPTION
list activated tokens
See code: src/commands/tokens/list.ts
remove supported tokens from the registry
USAGE
$ airswap tokens:remove
DESCRIPTION
remove supported tokens from the registry
See code: src/commands/tokens/remove.ts
transfer tokens to another account
USAGE
$ airswap transfer
DESCRIPTION
transfer tokens to another account
See code: src/commands/transfer.ts
deposit eth to weth
USAGE
$ airswap wrapped:deposit
DESCRIPTION
deposit eth to weth
See code: src/commands/wrapped/deposit.ts
withdraw eth from weth
USAGE
$ airswap wrapped:withdraw
DESCRIPTION
withdraw eth from weth
See code: src/commands/wrapped/withdraw.ts