{"id":23869111,"url":"https://github.com/airswap/airswap-cli","last_synced_at":"2025-03-05T00:02:27.770Z","repository":{"id":42189856,"uuid":"216430863","full_name":"airswap/airswap-cli","owner":"airswap","description":"AirSwap Command-line Interface","archived":false,"fork":false,"pushed_at":"2024-09-01T21:14:20.000Z","size":2895,"stargazers_count":23,"open_issues_count":4,"forks_count":12,"subscribers_count":10,"default_branch":"main","last_synced_at":"2024-09-19T03:14:17.529Z","etag":null,"topics":["cli","ethereum"],"latest_commit_sha":null,"homepage":"https://about.airswap.io/","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/airswap.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-10-20T21:37:55.000Z","updated_at":"2024-09-04T19:46:13.000Z","dependencies_parsed_at":"2024-02-07T16:27:36.709Z","dependency_job_id":"1f986f06-1f6b-4f77-9cd4-f9a46770a5e3","html_url":"https://github.com/airswap/airswap-cli","commit_stats":{"total_commits":358,"total_committers":8,"mean_commits":44.75,"dds":"0.26536312849162014","last_synced_commit":"1e08076173c796534d7555e672f32c072c2c326f"},"previous_names":[],"tags_count":45,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/airswap%2Fairswap-cli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/airswap%2Fairswap-cli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/airswap%2Fairswap-cli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/airswap%2Fairswap-cli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/airswap","download_url":"https://codeload.github.com/airswap/airswap-cli/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":241935266,"owners_count":20044826,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cli","ethereum"],"created_at":"2025-01-03T12:15:58.849Z","updated_at":"2025-03-05T00:02:27.729Z","avatar_url":"https://github.com/airswap.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# AirSwap CLI\n\nCommand Line Interface (CLI) for the AirSwap Network\n\n[![Version](https://img.shields.io/npm/v/airswap.svg)](https://npmjs.org/package/airswap)\n[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)\n[![Downloads/week](https://img.shields.io/npm/dw/airswap.svg)](https://npmjs.org/package/airswap)\n[![Discord](https://img.shields.io/discord/590643190281928738.svg)](https://discord.gg/ecQbV7H)\n![Twitter Follow](https://img.shields.io/twitter/follow/airswap?style=social)\n\n- About → https://about.airswap.io/\n- Website → https://www.airswap.io/\n- Blog → https://blog.airswap.io/\n\n**Key Management**\n\nAirSwap 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.\n\n# Quick Start\n\nInstall the CLI globally\n\n```\n$ yarn global add airswap\n```\n\nCreate a new account to use for the CLI (recommended)\n\n```\n$ airswap account:generate\n```\n\nImport the newly generated or an existing private key\n\n```\n$ airswap account:import\n```\n\nSet the active chain\n\n```\n$ airswap chain\n```\n\n# All Commands\n\n\u003c!-- commands --\u003e\n* [`airswap account:delete`](#airswap-accountdelete)\n* [`airswap account:export`](#airswap-accountexport)\n* [`airswap account:generate`](#airswap-accountgenerate)\n* [`airswap account:import`](#airswap-accountimport)\n* [`airswap approve`](#airswap-approve)\n* [`airswap balances`](#airswap-balances)\n* [`airswap best`](#airswap-best)\n* [`airswap chain`](#airswap-chain)\n* [`airswap delegate:authorize`](#airswap-delegateauthorize)\n* [`airswap delegate:revoke`](#airswap-delegaterevoke)\n* [`airswap delegate:set`](#airswap-delegateset)\n* [`airswap delegate:swap`](#airswap-delegateswap)\n* [`airswap delegate:unset`](#airswap-delegateunset)\n* [`airswap gas`](#airswap-gas)\n* [`airswap help [COMMANDS]`](#airswap-help-commands)\n* [`airswap inspect`](#airswap-inspect)\n* [`airswap ip`](#airswap-ip)\n* [`airswap metadata:add`](#airswap-metadataadd)\n* [`airswap metadata:delete`](#airswap-metadatadelete)\n* [`airswap metadata:lookup`](#airswap-metadatalookup)\n* [`airswap metadata:update`](#airswap-metadataupdate)\n* [`airswap order`](#airswap-order)\n* [`airswap protocols:add`](#airswap-protocolsadd)\n* [`airswap protocols:list`](#airswap-protocolslist)\n* [`airswap protocols:remove`](#airswap-protocolsremove)\n* [`airswap registry:approve`](#airswap-registryapprove)\n* [`airswap registry:eject`](#airswap-registryeject)\n* [`airswap registry:list`](#airswap-registrylist)\n* [`airswap registry:revoke`](#airswap-registryrevoke)\n* [`airswap registry:status`](#airswap-registrystatus)\n* [`airswap registry:url`](#airswap-registryurl)\n* [`airswap revoke`](#airswap-revoke)\n* [`airswap stream`](#airswap-stream)\n* [`airswap tokens:add`](#airswap-tokensadd)\n* [`airswap tokens:list`](#airswap-tokenslist)\n* [`airswap tokens:remove`](#airswap-tokensremove)\n* [`airswap transfer`](#airswap-transfer)\n* [`airswap wrapped:deposit`](#airswap-wrappeddeposit)\n* [`airswap wrapped:withdraw`](#airswap-wrappedwithdraw)\n\n## `airswap account:delete`\n\ndelete the current ethereum account\n\n```\nUSAGE\n  $ airswap account:delete\n\nDESCRIPTION\n  delete the current ethereum account\n```\n\n_See code: [src/commands/account/delete.ts](https://github.com/airswap/airswap-cli/blob/v5.0.3/src/commands/account/delete.ts)_\n\n## `airswap account:export`\n\nexport the current ethereum account\n\n```\nUSAGE\n  $ airswap account:export\n\nDESCRIPTION\n  export the current ethereum account\n```\n\n_See code: [src/commands/account/export.ts](https://github.com/airswap/airswap-cli/blob/v5.0.3/src/commands/account/export.ts)_\n\n## `airswap account:generate`\n\ngenerate a new ethereum account\n\n```\nUSAGE\n  $ airswap account:generate\n\nDESCRIPTION\n  generate a new ethereum account\n```\n\n_See code: [src/commands/account/generate.ts](https://github.com/airswap/airswap-cli/blob/v5.0.3/src/commands/account/generate.ts)_\n\n## `airswap account:import`\n\nimport an ethereum account\n\n```\nUSAGE\n  $ airswap account:import\n\nDESCRIPTION\n  import an ethereum account\n```\n\n_See code: [src/commands/account/import.ts](https://github.com/airswap/airswap-cli/blob/v5.0.3/src/commands/account/import.ts)_\n\n## `airswap approve`\n\napprove a token for trading\n\n```\nUSAGE\n  $ airswap approve\n\nDESCRIPTION\n  approve a token for trading\n```\n\n_See code: [src/commands/approve.ts](https://github.com/airswap/airswap-cli/blob/v5.0.3/src/commands/approve.ts)_\n\n## `airswap balances`\n\ndisplay token balances\n\n```\nUSAGE\n  $ airswap balances\n\nDESCRIPTION\n  display token balances\n```\n\n_See code: [src/commands/balances.ts](https://github.com/airswap/airswap-cli/blob/v5.0.3/src/commands/balances.ts)_\n\n## `airswap best`\n\ncompare order pricing from servers\n\n```\nUSAGE\n  $ airswap best\n\nDESCRIPTION\n  compare order pricing from servers\n```\n\n_See code: [src/commands/best.ts](https://github.com/airswap/airswap-cli/blob/v5.0.3/src/commands/best.ts)_\n\n## `airswap chain`\n\nset the active chain\n\n```\nUSAGE\n  $ airswap chain\n\nDESCRIPTION\n  set the active chain\n```\n\n_See code: [src/commands/chain.ts](https://github.com/airswap/airswap-cli/blob/v5.0.3/src/commands/chain.ts)_\n\n## `airswap delegate:authorize`\n\nauthorize a rule manager\n\n```\nUSAGE\n  $ airswap delegate:authorize\n\nDESCRIPTION\n  authorize a rule manager\n```\n\n_See code: [src/commands/delegate/authorize.ts](https://github.com/airswap/airswap-cli/blob/v5.0.3/src/commands/delegate/authorize.ts)_\n\n## `airswap delegate:revoke`\n\nrevoke a rule manager\n\n```\nUSAGE\n  $ airswap delegate:revoke\n\nDESCRIPTION\n  revoke a rule manager\n```\n\n_See code: [src/commands/delegate/revoke.ts](https://github.com/airswap/airswap-cli/blob/v5.0.3/src/commands/delegate/revoke.ts)_\n\n## `airswap delegate:set`\n\nset a delegate rule\n\n```\nUSAGE\n  $ airswap delegate:set\n\nDESCRIPTION\n  set a delegate rule\n```\n\n_See code: [src/commands/delegate/set.ts](https://github.com/airswap/airswap-cli/blob/v5.0.3/src/commands/delegate/set.ts)_\n\n## `airswap delegate:swap`\n\nswap with the delegate\n\n```\nUSAGE\n  $ airswap delegate:swap\n\nDESCRIPTION\n  swap with the delegate\n```\n\n_See code: [src/commands/delegate/swap.ts](https://github.com/airswap/airswap-cli/blob/v5.0.3/src/commands/delegate/swap.ts)_\n\n## `airswap delegate:unset`\n\nunset a delegate rule\n\n```\nUSAGE\n  $ airswap delegate:unset\n\nDESCRIPTION\n  unset a delegate rule\n```\n\n_See code: [src/commands/delegate/unset.ts](https://github.com/airswap/airswap-cli/blob/v5.0.3/src/commands/delegate/unset.ts)_\n\n## `airswap gas`\n\nset gas price for transactions\n\n```\nUSAGE\n  $ airswap gas\n\nDESCRIPTION\n  set gas price for transactions\n```\n\n_See code: [src/commands/gas.ts](https://github.com/airswap/airswap-cli/blob/v5.0.3/src/commands/gas.ts)_\n\n## `airswap help [COMMANDS]`\n\nDisplay help for airswap.\n\n```\nUSAGE\n  $ airswap help [COMMANDS] [-n]\n\nARGUMENTS\n  COMMANDS  Command to show help for.\n\nFLAGS\n  -n, --nested-commands  Include all nested commands in the output.\n\nDESCRIPTION\n  Display help for airswap.\n```\n\n_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v5.2.20/src/commands/help.ts)_\n\n## `airswap inspect`\n\ninspect protocols for a server\n\n```\nUSAGE\n  $ airswap inspect\n\nDESCRIPTION\n  inspect protocols for a server\n```\n\n_See code: [src/commands/inspect.ts](https://github.com/airswap/airswap-cli/blob/v5.0.3/src/commands/inspect.ts)_\n\n## `airswap ip`\n\ndisplay local network addresses\n\n```\nUSAGE\n  $ airswap ip\n\nDESCRIPTION\n  display local network addresses\n```\n\n_See code: [src/commands/ip.ts](https://github.com/airswap/airswap-cli/blob/v5.0.3/src/commands/ip.ts)_\n\n## `airswap metadata:add`\n\nadd token to local metadata\n\n```\nUSAGE\n  $ airswap metadata:add\n\nDESCRIPTION\n  add token to local metadata\n```\n\n_See code: [src/commands/metadata/add.ts](https://github.com/airswap/airswap-cli/blob/v5.0.3/src/commands/metadata/add.ts)_\n\n## `airswap metadata:delete`\n\ndelete token from local metadata\n\n```\nUSAGE\n  $ airswap metadata:delete\n\nDESCRIPTION\n  delete token from local metadata\n```\n\n_See code: [src/commands/metadata/delete.ts](https://github.com/airswap/airswap-cli/blob/v5.0.3/src/commands/metadata/delete.ts)_\n\n## `airswap metadata:lookup`\n\nlookup token in local metadata\n\n```\nUSAGE\n  $ airswap metadata:lookup\n\nDESCRIPTION\n  lookup token in local metadata\n```\n\n_See code: [src/commands/metadata/lookup.ts](https://github.com/airswap/airswap-cli/blob/v5.0.3/src/commands/metadata/lookup.ts)_\n\n## `airswap metadata:update`\n\nupdate local metadata from remote sources\n\n```\nUSAGE\n  $ airswap metadata:update\n\nDESCRIPTION\n  update local metadata from remote sources\n```\n\n_See code: [src/commands/metadata/update.ts](https://github.com/airswap/airswap-cli/blob/v5.0.3/src/commands/metadata/update.ts)_\n\n## `airswap order`\n\nget an order from a server\n\n```\nUSAGE\n  $ airswap order\n\nDESCRIPTION\n  get an order from a server\n```\n\n_See code: [src/commands/order.ts](https://github.com/airswap/airswap-cli/blob/v5.0.3/src/commands/order.ts)_\n\n## `airswap protocols:add`\n\nadd supported protocols to the registry\n\n```\nUSAGE\n  $ airswap protocols:add\n\nDESCRIPTION\n  add supported protocols to the registry\n```\n\n_See code: [src/commands/protocols/add.ts](https://github.com/airswap/airswap-cli/blob/v5.0.3/src/commands/protocols/add.ts)_\n\n## `airswap protocols:list`\n\nlist activated protocols\n\n```\nUSAGE\n  $ airswap protocols:list\n\nDESCRIPTION\n  list activated protocols\n```\n\n_See code: [src/commands/protocols/list.ts](https://github.com/airswap/airswap-cli/blob/v5.0.3/src/commands/protocols/list.ts)_\n\n## `airswap protocols:remove`\n\nremove supported protocols from the registry\n\n```\nUSAGE\n  $ airswap protocols:remove\n\nDESCRIPTION\n  remove supported protocols from the registry\n```\n\n_See code: [src/commands/protocols/remove.ts](https://github.com/airswap/airswap-cli/blob/v5.0.3/src/commands/protocols/remove.ts)_\n\n## `airswap registry:approve`\n\nenable staking on the registry\n\n```\nUSAGE\n  $ airswap registry:approve\n\nDESCRIPTION\n  enable staking on the registry\n```\n\n_See code: [src/commands/registry/approve.ts](https://github.com/airswap/airswap-cli/blob/v5.0.3/src/commands/registry/approve.ts)_\n\n## `airswap registry:eject`\n\nremove url, protocols, and tokens from registry\n\n```\nUSAGE\n  $ airswap registry:eject\n\nDESCRIPTION\n  remove url, protocols, and tokens from registry\n```\n\n_See code: [src/commands/registry/eject.ts](https://github.com/airswap/airswap-cli/blob/v5.0.3/src/commands/registry/eject.ts)_\n\n## `airswap registry:list`\n\nget urls from the registry\n\n```\nUSAGE\n  $ airswap registry:list\n\nDESCRIPTION\n  get urls from the registry\n```\n\n_See code: [src/commands/registry/list.ts](https://github.com/airswap/airswap-cli/blob/v5.0.3/src/commands/registry/list.ts)_\n\n## `airswap registry:revoke`\n\ndisable staking on the registry\n\n```\nUSAGE\n  $ airswap registry:revoke\n\nDESCRIPTION\n  disable staking on the registry\n```\n\n_See code: [src/commands/registry/revoke.ts](https://github.com/airswap/airswap-cli/blob/v5.0.3/src/commands/registry/revoke.ts)_\n\n## `airswap registry:status`\n\ncheck status of url, protocols, and tokens on registry\n\n```\nUSAGE\n  $ airswap registry:status\n\nDESCRIPTION\n  check status of url, protocols, and tokens on registry\n```\n\n_See code: [src/commands/registry/status.ts](https://github.com/airswap/airswap-cli/blob/v5.0.3/src/commands/registry/status.ts)_\n\n## `airswap registry:url`\n\nset server url on the registry\n\n```\nUSAGE\n  $ airswap registry:url\n\nDESCRIPTION\n  set server url on the registry\n```\n\n_See code: [src/commands/registry/url.ts](https://github.com/airswap/airswap-cli/blob/v5.0.3/src/commands/registry/url.ts)_\n\n## `airswap revoke`\n\nrevoke a token approval\n\n```\nUSAGE\n  $ airswap revoke\n\nDESCRIPTION\n  revoke a token approval\n```\n\n_See code: [src/commands/revoke.ts](https://github.com/airswap/airswap-cli/blob/v5.0.3/src/commands/revoke.ts)_\n\n## `airswap stream`\n\nstream quotes for a swap\n\n```\nUSAGE\n  $ airswap stream\n\nDESCRIPTION\n  stream quotes for a swap\n```\n\n_See code: [src/commands/stream.ts](https://github.com/airswap/airswap-cli/blob/v5.0.3/src/commands/stream.ts)_\n\n## `airswap tokens:add`\n\nadd supported tokens to the registry\n\n```\nUSAGE\n  $ airswap tokens:add\n\nDESCRIPTION\n  add supported tokens to the registry\n```\n\n_See code: [src/commands/tokens/add.ts](https://github.com/airswap/airswap-cli/blob/v5.0.3/src/commands/tokens/add.ts)_\n\n## `airswap tokens:list`\n\nlist activated tokens\n\n```\nUSAGE\n  $ airswap tokens:list\n\nDESCRIPTION\n  list activated tokens\n```\n\n_See code: [src/commands/tokens/list.ts](https://github.com/airswap/airswap-cli/blob/v5.0.3/src/commands/tokens/list.ts)_\n\n## `airswap tokens:remove`\n\nremove supported tokens from the registry\n\n```\nUSAGE\n  $ airswap tokens:remove\n\nDESCRIPTION\n  remove supported tokens from the registry\n```\n\n_See code: [src/commands/tokens/remove.ts](https://github.com/airswap/airswap-cli/blob/v5.0.3/src/commands/tokens/remove.ts)_\n\n## `airswap transfer`\n\ntransfer tokens to another account\n\n```\nUSAGE\n  $ airswap transfer\n\nDESCRIPTION\n  transfer tokens to another account\n```\n\n_See code: [src/commands/transfer.ts](https://github.com/airswap/airswap-cli/blob/v5.0.3/src/commands/transfer.ts)_\n\n## `airswap wrapped:deposit`\n\ndeposit eth to weth\n\n```\nUSAGE\n  $ airswap wrapped:deposit\n\nDESCRIPTION\n  deposit eth to weth\n```\n\n_See code: [src/commands/wrapped/deposit.ts](https://github.com/airswap/airswap-cli/blob/v5.0.3/src/commands/wrapped/deposit.ts)_\n\n## `airswap wrapped:withdraw`\n\nwithdraw eth from weth\n\n```\nUSAGE\n  $ airswap wrapped:withdraw\n\nDESCRIPTION\n  withdraw eth from weth\n```\n\n_See code: [src/commands/wrapped/withdraw.ts](https://github.com/airswap/airswap-cli/blob/v5.0.3/src/commands/wrapped/withdraw.ts)_\n\u003c!-- commandsstop --\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fairswap%2Fairswap-cli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fairswap%2Fairswap-cli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fairswap%2Fairswap-cli/lists"}