{"id":27446442,"url":"https://github.com/AstarNetwork/swanky-cli","last_synced_at":"2025-04-15T05:01:11.701Z","repository":{"id":47293175,"uuid":"493215275","full_name":"inkdevhub/swanky-cli","owner":"inkdevhub","description":"The all-in-one developer environment for Parity pallet-contracts based smart contracts!","archived":false,"fork":false,"pushed_at":"2024-04-01T15:47:54.000Z","size":2064,"stargazers_count":73,"open_issues_count":23,"forks_count":31,"subscribers_count":7,"default_branch":"master","last_synced_at":"2025-04-11T02:17:53.176Z","etag":null,"topics":["blockchain","cli","webassembly"],"latest_commit_sha":null,"homepage":"https://docs.astar.network/docs/build/wasm/swanky-suite/cli/","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/inkdevhub.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":"2022-05-17T11:09:33.000Z","updated_at":"2025-03-04T03:10:56.000Z","dependencies_parsed_at":"2023-07-28T15:05:25.724Z","dependency_job_id":"849567cf-483d-4dfd-8923-fa9e458fde6c","html_url":"https://github.com/inkdevhub/swanky-cli","commit_stats":null,"previous_names":["astarnetwork/swanky-cli","swankyhub/swanky-cli"],"tags_count":76,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/inkdevhub%2Fswanky-cli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/inkdevhub%2Fswanky-cli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/inkdevhub%2Fswanky-cli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/inkdevhub%2Fswanky-cli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/inkdevhub","download_url":"https://codeload.github.com/inkdevhub/swanky-cli/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249010212,"owners_count":21197797,"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":["blockchain","cli","webassembly"],"created_at":"2025-04-15T05:00:37.649Z","updated_at":"2025-04-15T05:01:11.619Z","avatar_url":"https://github.com/inkdevhub.png","language":"TypeScript","funding_links":[],"categories":["Ink Smart Contract Examples"],"sub_categories":["Consumer Contract Examples"],"readme":"\u003cp align=\"center\"\u003e\n\u003cimg src=\"https://github.com/inkdevhub/swanky-cli/blob/master/logo.png\" width=500/\u003e\n\u003c/p\u003e\n\n\u003c!-- toc --\u003e\n* [Docs and guide](#docs-and-guide)\n* [Quick start](#quick-start)\n* [Base image and dev container](#base-image-and-dev-container)\n* [Config](#config)\n* [Network Management](#network-management)\n* [Development and contributing](#development-and-contributing)\n* [Reporting issues](#reporting-issues)\n* [Command help](#command-help)\n\u003c!-- tocstop --\u003e\n\n# Docs and guide\n\nYou can find more detailed info on installing and using Swanky CLI on [official astar docs page](https://docs.astar.network/docs/build/wasm/swanky-suite/cli/)\n\n# Quick start\n\nIf you use a devcontainer (see next section), or a [`swanky-base`](https://github.com/inkdevhub/swanky-cli/pkgs/container/swanky-cli%2Fswanky-base) image, swanky will be preinstalled and globally available and you can use it to generate and develop smart contracts right away.\n\nOtherwise, you can install it from [`npm`](https://www.npmjs.com/package/@astar-network/swanky-cli), or download the [binaries for your system](https://github.com/inkdevhub/swanky-cli/releases/)\n\nFor a quick start, you can run\n\n```\nswanky init my_project_name\n```\n\nThen cd into the project and compile:\n\n```\nswanky contract compile my_contract_name\n```\n\nOnce done, open a new terminal window and start the node (assuming you chose to download it. If not, skip this part, edit the config to point to your node and use `--network` flag when deploying):\n\n```\nswanky node start\n```\n\nand, assuming you contract is based on flipper template and it's called flipper:\n\n```\nswanky contract deploy flipper --account alice -a true\n```\n\nNow you can interact with it by `query` and `tx` commands:\n\n```\nswanky contract query flipper get\nswanky contract tx flipper flip --account alice\n```\n\nYour tests are located in the `/test` directory, and can be run either by calling `yarn test`, or `swanky contract test contract_name`.\n\nThe latter will produce a web-based report, but is unstable at the moment and might not work correctly.\n\n# Base image and dev container\n\nThis repo hosts a pre built Docker image that comes with the latest version of swanky-cli installed, as well as required dependencies.\n\nYou can use it directly as a container on your machine, or as a base for a dev container (or codespaces).\n\n[Here is a template repo with a .devcontainer preconfigured](https://github.com/inkdevhub/swanky-dev-container).\n\nTo use it, create a new repo from the template, and either start a devcontainer locally, or run it in a GitHub Codespace\n\n# Config\n\nA newly generated project will have a `swanky.config.json` file that will get populated as you interact with your contracts and accounts.\n\n## Example:\n\n```json\n{\n  \"node\": {\n    \"localPath\": \"/Users/sasapul/Work/astar/swanky-cli/temp_proj/bin/swanky-node\",\n    \"polkadotPalletVersions\": \"polkadot-v0.9.39\",\n    \"supportedInk\": \"v5.0.0\"\n  },\n  \"accounts\": [\n    {\n      \"alias\": \"alice\",\n      \"mnemonic\": \"//Alice\",\n      \"isDev\": true,\n      \"address\": \"5GrwvaEF5zXb26Fz9rcQpDWS57CtERHpNehXCPcNoHGKutQY\"\n    },\n    {\n      \"alias\": \"bob\",\n      \"mnemonic\": \"//Bob\",\n      \"isDev\": true,\n      \"address\": \"5FHneW46xGXgs5mUiveU4sbTyGBzmstUspZC92UhjJM694ty\"\n    }\n  ],\n  \"networks\": {\n    \"local\": {\n      \"url\": \"ws://127.0.0.1:9944\"\n    },\n    \"astar\": {\n      \"url\": \"wss://rpc.astar.network\"\n    },\n    \"shiden\": {\n      \"url\": \"wss://rpc.shiden.astar.network\"\n    },\n    \"shibuya\": {\n      \"url\": \"wss://shibuya.public.blastapi.io\"\n    }\n  },\n  \"contracts\": {\n    \"flipper\": {\n      \"name\": \"flipper\",\n      \"moduleName\": \"flipper\",\n      \"deployments\": [\n        {\n          \"timestamp\": 1685526140801,\n          \"address\": \"5GsW2psSHADG1rSe6eZLof2qvSj7EV5KFcP5SQLswyZdoPsq\",\n          \"networkUrl\": \"ws://127.0.0.1:9944\",\n          \"deployerAlias\": \"alice\"\n        }\n      ]\n    }\n  }\n}\n```\n\nAlso, global config will be created in your home directory, in `~/swanky` folder.\n\n## Example:\n\n```json\n{\n  \"accounts\": [\n    {\n      \"alias\": \"alice\",\n      \"mnemonic\": \"//Alice\",\n      \"isDev\": true,\n      \"address\": \"5GrwvaEF5zXb26Fz9rcQpDWS57CtERHpNehXCPcNoHGKutQY\"\n    },\n    {\n      \"alias\": \"bob\",\n      \"mnemonic\": \"//Bob\",\n      \"isDev\": true,\n      \"address\": \"5FHneW46xGXgs5mUiveU4sbTyGBzmstUspZC92UhjJM694ty\"\n    },\n    {\n      \"mnemonic\": \"broken estate advance smooth noble place wine choose scare east effort evil\",\n      \"isDev\": true,\n      \"alias\": \"global\",\n      \"address\": \"5FhfjMxbrJnjxuP5rP1ZorNaDJdE1n5LYpd7jTi9ByfVX1P1\"\n    }\n  ],\n  \"networks\": {\n    \"local\": {\n      \"url\": \"ws://127.0.0.1:9944\"\n    },\n    \"astar\": {\n      \"url\": \"wss://rpc.astar.network\"\n    },\n    \"shiden\": {\n      \"url\": \"wss://rpc.shiden.astar.network\"\n    },\n    \"shibuya\": {\n      \"url\": \"wss://shibuya.public.blastapi.io\"\n    }\n  }\n}\n```\n\nYou can use accounts and networks from the global config in any swanky project.\n\n# Network Management\n\nYou can deploy/call wasm smart contracts on any chains supporting the substrate contracts module ([`pallet-contracts`](https://github.com/paritytech/substrate/tree/master/frame/contracts)) by swanky-cli.\n`--network` flag is available for `deploy` and `query`/`tx` commands. For example,\n\n```\nswanky contract deploy flipper --account alice --gas 100000000000 --args true --network shibuya\n```\n\nBy default, `swanky init` prepares local/astar/shiden/shibuya endpoint for you.\nTo add networks or change endpoint to interact with, you need to update `swanky.config.json` `networks` section.\n\n```\n\"networks\": {\n  \"local\": {\n    \"url\": \"ws://127.0.0.1:9944\"\n  },\n  \"your_network\": {\n    \"url\": \"wss://your.network\"\n  }\n}\n```\n\n# Development and contributing\n\nTo work on swanky-cli itself, you'll need nodeJs, `yarn`, and `ts-node` installed globally.\n\nRunning `yarn dev` will start a watch process for both `ts` files and `/templates`, and you can run it by calling:\n\n```\nyarn dev:run COMMAND\n```\n\nor directly\n\n```\n./bin/run.js COMMAND\n```\n\nDirectory names `temp_project`, `temp_proj`, and `test_project` are ignored by git so it's safe to test in the root directory of the project.\n\nFor example\n\n```\n./bin/run.js init temp_project\ncd temp_project\n../bin/run.js contract compile flipper\n```\n\n# Reporting issues\n\nPlease report any issue or bug you encounter, as well as any feature and improvement requests to the [issues section](https://github.com/inkdevhub/swanky-cli/issues)\n\n# Command help\n\n\u003c!-- usage --\u003e\n```sh-session\n$ npm install -g @astar-network/swanky-cli\n$ swanky COMMAND\nrunning command...\n$ swanky (--version|-V|-v)\n@astar-network/swanky-cli/4.0.0 darwin-x64 node-v21.7.1\n$ swanky --help [COMMAND]\nUSAGE\n  $ swanky COMMAND\n...\n```\n\u003c!-- usagestop --\u003e\n\n\u003c!-- commands --\u003e\n* [`swanky account balance [ALIAS]`](#swanky-account-balance-alias)\n* [`swanky account create`](#swanky-account-create)\n* [`swanky account default [ACCOUNTALIAS]`](#swanky-account-default-accountalias)\n* [`swanky account faucet ALIAS`](#swanky-account-faucet-alias)\n* [`swanky account list`](#swanky-account-list)\n* [`swanky account ls`](#swanky-account-ls)\n* [`swanky clear [CONTRACTNAME]`](#swanky-clear-contractname)\n* [`swanky contract compile [CONTRACTNAME]`](#swanky-contract-compile-contractname)\n* [`swanky contract deploy CONTRACTNAME`](#swanky-contract-deploy-contractname)\n* [`swanky contract explain CONTRACTNAME`](#swanky-contract-explain-contractname)\n* [`swanky contract new CONTRACTNAME`](#swanky-contract-new-contractname)\n* [`swanky contract query CONTRACTNAME MESSAGENAME`](#swanky-contract-query-contractname-messagename)\n* [`swanky contract test [CONTRACTNAME]`](#swanky-contract-test-contractname)\n* [`swanky contract tx CONTRACTNAME MESSAGENAME`](#swanky-contract-tx-contractname-messagename)\n* [`swanky contract verify [CONTRACTNAME]`](#swanky-contract-verify-contractname)\n* [`swanky env check`](#swanky-env-check)\n* [`swanky env install`](#swanky-env-install)\n* [`swanky generate tests [CONTRACTNAME]`](#swanky-generate-tests-contractname)\n* [`swanky generate types CONTRACTNAME`](#swanky-generate-types-contractname)\n* [`swanky help [COMMAND]`](#swanky-help-command)\n* [`swanky init PROJECTNAME`](#swanky-init-projectname)\n* [`swanky node chopsticks init`](#swanky-node-chopsticks-init)\n* [`swanky node chopsticks start`](#swanky-node-chopsticks-start)\n* [`swanky node install`](#swanky-node-install)\n* [`swanky node purge`](#swanky-node-purge)\n* [`swanky node start`](#swanky-node-start)\n* [`swanky node version`](#swanky-node-version)\n* [`swanky plugins`](#swanky-plugins)\n* [`swanky plugins:install PLUGIN...`](#swanky-pluginsinstall-plugin)\n* [`swanky plugins:inspect PLUGIN...`](#swanky-pluginsinspect-plugin)\n* [`swanky plugins:install PLUGIN...`](#swanky-pluginsinstall-plugin-1)\n* [`swanky plugins:link PLUGIN`](#swanky-pluginslink-plugin)\n* [`swanky plugins:uninstall PLUGIN...`](#swanky-pluginsuninstall-plugin)\n* [`swanky plugins reset`](#swanky-plugins-reset)\n* [`swanky plugins:uninstall PLUGIN...`](#swanky-pluginsuninstall-plugin-1)\n* [`swanky plugins:uninstall PLUGIN...`](#swanky-pluginsuninstall-plugin-2)\n* [`swanky plugins update`](#swanky-plugins-update)\n* [`swanky version`](#swanky-version)\n* [`swanky zombienet init`](#swanky-zombienet-init)\n* [`swanky zombienet start`](#swanky-zombienet-start)\n\n## `swanky account balance [ALIAS]`\n\nBalance of an account\n\n```\nUSAGE\n  $ swanky account balance [ALIAS] [-v]\n\nARGUMENTS\n  ALIAS  Alias of account to be used\n\nFLAGS\n  -v, --verbose  Display more info in the result logs\n\nDESCRIPTION\n  Balance of an account\n```\n\n_See code: [src/commands/account/balance.ts](https://github.com/inkdevhub/swanky-cli/blob/v4.0.0/src/commands/account/balance.ts)_\n\n## `swanky account create`\n\nCreate a new dev account in config\n\n```\nUSAGE\n  $ swanky account create [-v] [-g] [-n] [-d]\n\nFLAGS\n  -d, --dev      Make this account a dev account for local network usage.\n  -g, --global   Create account globally stored in Swanky system config.\n  -n, --new      Generate a brand new account.\n  -v, --verbose  Display more info in the result logs\n\nDESCRIPTION\n  Create a new dev account in config\n```\n\n_See code: [src/commands/account/create.ts](https://github.com/inkdevhub/swanky-cli/blob/v4.0.0/src/commands/account/create.ts)_\n\n## `swanky account default [ACCOUNTALIAS]`\n\nSet default account to use\n\n```\nUSAGE\n  $ swanky account default [ACCOUNTALIAS] [-v] [-g]\n\nARGUMENTS\n  ACCOUNTALIAS  Alias of account to be used as default\n\nFLAGS\n  -g, --global   Set default account globally in Swanky system config.\n  -v, --verbose  Display more info in the result logs\n\nDESCRIPTION\n  Set default account to use\n```\n\n_See code: [src/commands/account/default.ts](https://github.com/inkdevhub/swanky-cli/blob/v4.0.0/src/commands/account/default.ts)_\n\n## `swanky account faucet ALIAS`\n\nTransfer some tokens from faucet to an account\n\n```\nUSAGE\n  $ swanky account faucet ALIAS [-v]\n\nARGUMENTS\n  ALIAS  Alias of account to be used\n\nFLAGS\n  -v, --verbose  Display more info in the result logs\n\nDESCRIPTION\n  Transfer some tokens from faucet to an account\n```\n\n_See code: [src/commands/account/faucet.ts](https://github.com/inkdevhub/swanky-cli/blob/v4.0.0/src/commands/account/faucet.ts)_\n\n## `swanky account list`\n\nList dev accounts stored in config\n\n```\nUSAGE\n  $ swanky account list [-v]\n\nFLAGS\n  -v, --verbose  Display more info in the result logs\n\nDESCRIPTION\n  List dev accounts stored in config\n\nALIASES\n  $ swanky account ls\n```\n\n_See code: [src/commands/account/list.ts](https://github.com/inkdevhub/swanky-cli/blob/v4.0.0/src/commands/account/list.ts)_\n\n## `swanky account ls`\n\nList dev accounts stored in config\n\n```\nUSAGE\n  $ swanky account ls [-v]\n\nFLAGS\n  -v, --verbose  Display more info in the result logs\n\nDESCRIPTION\n  List dev accounts stored in config\n\nALIASES\n  $ swanky account ls\n```\n\n## `swanky clear [CONTRACTNAME]`\n\n```\nUSAGE\n  $ swanky clear [CONTRACTNAME] [-v] [-a]\n\nARGUMENTS\n  CONTRACTNAME  Name of the contract artifact to clear\n\nFLAGS\n  -a, --all      Select all the project artifacts for delete\n  -v, --verbose  Display more info in the result logs\n```\n\n_See code: [src/commands/clear/index.ts](https://github.com/inkdevhub/swanky-cli/blob/v4.0.0/src/commands/clear/index.ts)_\n\n## `swanky contract compile [CONTRACTNAME]`\n\nCompile the smart contract(s) in your contracts directory\n\n```\nUSAGE\n  $ swanky contract compile [CONTRACTNAME] [-v] [-r] [--verifiable] [-a]\n\nARGUMENTS\n  CONTRACTNAME  Name of the contract to compile\n\nFLAGS\n  -a, --all         Set all to true to compile all contracts\n  -r, --release     A production contract should always be build in `release` mode for building optimized wasm\n  -v, --verbose     Display more info in the result logs\n      --verifiable  A production contract should be build in `verifiable` mode to deploy on a public network. Ensure\n                    Docker Engine is up and running.\n\nDESCRIPTION\n  Compile the smart contract(s) in your contracts directory\n```\n\n_See code: [src/commands/contract/compile.ts](https://github.com/inkdevhub/swanky-cli/blob/v4.0.0/src/commands/contract/compile.ts)_\n\n## `swanky contract deploy CONTRACTNAME`\n\nDeploy contract to a running node\n\n```\nUSAGE\n  $ swanky contract deploy CONTRACTNAME [-v] [--account \u003cvalue\u003e] [-g \u003cvalue\u003e] [-a \u003cvalue\u003e] [-c \u003cvalue\u003e] [-n \u003cvalue\u003e]\n\nARGUMENTS\n  CONTRACTNAME  Name of the contract to deploy\n\nFLAGS\n  -a, --args=\u003cvalue\u003e...\n  -c, --constructorName=\u003cvalue\u003e  [default: new] Constructor function name of a contract to deploy\n  -g, --gas=\u003cvalue\u003e\n  -n, --network=\u003cvalue\u003e          [default: local] Network name to connect to\n  -v, --verbose                  Display more info in the result logs\n      --account=\u003cvalue\u003e          Account alias to deploy contract with\n\nDESCRIPTION\n  Deploy contract to a running node\n```\n\n_See code: [src/commands/contract/deploy.ts](https://github.com/inkdevhub/swanky-cli/blob/v4.0.0/src/commands/contract/deploy.ts)_\n\n## `swanky contract explain CONTRACTNAME`\n\nExplain contract messages based on the contracts' metadata\n\n```\nUSAGE\n  $ swanky contract explain CONTRACTNAME [-v]\n\nARGUMENTS\n  CONTRACTNAME  Name of the contract\n\nFLAGS\n  -v, --verbose  Display more info in the result logs\n\nDESCRIPTION\n  Explain contract messages based on the contracts' metadata\n```\n\n_See code: [src/commands/contract/explain.ts](https://github.com/inkdevhub/swanky-cli/blob/v4.0.0/src/commands/contract/explain.ts)_\n\n## `swanky contract new CONTRACTNAME`\n\nGenerate a new smart contract template inside a project\n\n```\nUSAGE\n  $ swanky contract new CONTRACTNAME [-v] [--template blank|flipper|psp22]\n\nARGUMENTS\n  CONTRACTNAME  Name of the new contract\n\nFLAGS\n  -v, --verbose\n      --template=\u003coption\u003e  \u003coptions: blank|flipper|psp22\u003e\n\nDESCRIPTION\n  Generate a new smart contract template inside a project\n```\n\n_See code: [src/commands/contract/new.ts](https://github.com/inkdevhub/swanky-cli/blob/v4.0.0/src/commands/contract/new.ts)_\n\n## `swanky contract query CONTRACTNAME MESSAGENAME`\n\nCall a query message on smart contract\n\n```\nUSAGE\n  $ swanky contract query CONTRACTNAME MESSAGENAME [-v] [-p \u003cvalue\u003e] [-g \u003cvalue\u003e] [-n \u003cvalue\u003e] [-a \u003cvalue\u003e]\n    [--address \u003cvalue\u003e]\n\nARGUMENTS\n  CONTRACTNAME  Contract to call\n  MESSAGENAME   What message to call\n\nFLAGS\n  -a, --account=\u003cvalue\u003e    Account alias to sign the transaction with\n  -g, --gas=\u003cvalue\u003e        Manually specify gas limit\n  -n, --network=\u003cvalue\u003e    [default: local] Name of network to connect to\n  -p, --params=\u003cvalue\u003e...  [default: ] Arguments supplied to the message\n  -v, --verbose            Display more info in the result logs\n      --address=\u003cvalue\u003e    Target specific address, defaults to last deployed. (--addr, --add)\n\nDESCRIPTION\n  Call a query message on smart contract\n```\n\n_See code: [src/commands/contract/query.ts](https://github.com/inkdevhub/swanky-cli/blob/v4.0.0/src/commands/contract/query.ts)_\n\n## `swanky contract test [CONTRACTNAME]`\n\nRun tests for a given contact\n\n```\nUSAGE\n  $ swanky contract test [CONTRACTNAME] [-v] [-a] [--mocha]\n\nARGUMENTS\n  CONTRACTNAME  Name of the contract to test\n\nFLAGS\n  -a, --all      Run tests for all contracts\n  -v, --verbose  Display more info in the result logs\n      --mocha    Run tests with mocha\n\nDESCRIPTION\n  Run tests for a given contact\n```\n\n_See code: [src/commands/contract/test.ts](https://github.com/inkdevhub/swanky-cli/blob/v4.0.0/src/commands/contract/test.ts)_\n\n## `swanky contract tx CONTRACTNAME MESSAGENAME`\n\nCall a Tx message on smart contract\n\n```\nUSAGE\n  $ swanky contract tx CONTRACTNAME MESSAGENAME [-v] [-p \u003cvalue\u003e] [-g \u003cvalue\u003e] [-n \u003cvalue\u003e] [-a \u003cvalue\u003e]\n    [--address \u003cvalue\u003e] [-d]\n\nARGUMENTS\n  CONTRACTNAME  Contract to call\n  MESSAGENAME   What message to call\n\nFLAGS\n  -a, --account=\u003cvalue\u003e    Account alias to sign the transaction with\n  -d, --dry                Do a dry run, without signing the transaction\n  -g, --gas=\u003cvalue\u003e        Manually specify gas limit\n  -n, --network=\u003cvalue\u003e    [default: local] Name of network to connect to\n  -p, --params=\u003cvalue\u003e...  [default: ] Arguments supplied to the message\n  -v, --verbose            Display more info in the result logs\n      --address=\u003cvalue\u003e    Target specific address, defaults to last deployed. (--addr, --add)\n\nDESCRIPTION\n  Call a Tx message on smart contract\n```\n\n_See code: [src/commands/contract/tx.ts](https://github.com/inkdevhub/swanky-cli/blob/v4.0.0/src/commands/contract/tx.ts)_\n\n## `swanky contract verify [CONTRACTNAME]`\n\nVerify the smart contract(s) in your contracts directory\n\n```\nUSAGE\n  $ swanky contract verify [CONTRACTNAME] [-v] [-a]\n\nARGUMENTS\n  CONTRACTNAME  Name of the contract to verify\n\nFLAGS\n  -a, --all      Set all to true to verify all contracts\n  -v, --verbose  Display more info in the result logs\n\nDESCRIPTION\n  Verify the smart contract(s) in your contracts directory\n```\n\n_See code: [src/commands/contract/verify.ts](https://github.com/inkdevhub/swanky-cli/blob/v4.0.0/src/commands/contract/verify.ts)_\n\n## `swanky env check`\n\nCheck installed package versions and compatibility\n\n```\nUSAGE\n  $ swanky env check [-v] [-o \u003cvalue\u003e]\n\nFLAGS\n  -o, --print=\u003cvalue\u003e  File to write output to\n  -v, --verbose        Display more info in the result logs\n\nDESCRIPTION\n  Check installed package versions and compatibility\n```\n\n_See code: [src/commands/env/check.ts](https://github.com/inkdevhub/swanky-cli/blob/v4.0.0/src/commands/env/check.ts)_\n\n## `swanky env install`\n\nInstall dev dependencies\n\n```\nUSAGE\n  $ swanky env install [-v] [-d \u003cvalue\u003e]\n\nFLAGS\n  -d, --deps=\u003cvalue\u003e...  Install the specified dev dependency name and version in the format \u003cdependency@version\u003e. The\n                         following options are supported: rust, cargo-dylint, cargo-contract. For installing rust\n                         nightly version run: env install --deps rust@nightly\n  -v, --verbose          Display more info in the result logs\n\nDESCRIPTION\n  Install dev dependencies\n```\n\n_See code: [src/commands/env/install.ts](https://github.com/inkdevhub/swanky-cli/blob/v4.0.0/src/commands/env/install.ts)_\n\n## `swanky generate tests [CONTRACTNAME]`\n\nGenerate test files for the specified contract\n\n```\nUSAGE\n  $ swanky generate tests [CONTRACTNAME] [-v] [--template blank|flipper|psp22] [--mocha]\n\nARGUMENTS\n  CONTRACTNAME  Name of the contract\n\nFLAGS\n  -v, --verbose            Display more info in the result logs\n      --mocha              Generate mocha test files\n      --template=\u003coption\u003e  \u003coptions: blank|flipper|psp22\u003e\n\nDESCRIPTION\n  Generate test files for the specified contract\n```\n\n_See code: [src/commands/generate/tests.ts](https://github.com/inkdevhub/swanky-cli/blob/v4.0.0/src/commands/generate/tests.ts)_\n\n## `swanky generate types CONTRACTNAME`\n\nGenerate types from compiled contract metadata\n\n```\nUSAGE\n  $ swanky generate types CONTRACTNAME [-v]\n\nARGUMENTS\n  CONTRACTNAME  Name of the contract\n\nFLAGS\n  -v, --verbose  Display more info in the result logs\n\nDESCRIPTION\n  Generate types from compiled contract metadata\n```\n\n_See code: [src/commands/generate/types.ts](https://github.com/inkdevhub/swanky-cli/blob/v4.0.0/src/commands/generate/types.ts)_\n\n## `swanky help [COMMAND]`\n\nDisplay help for swanky.\n\n```\nUSAGE\n  $ swanky help [COMMAND...] [-n]\n\nARGUMENTS\n  COMMAND...  Command to show help for.\n\nFLAGS\n  -n, --nested-commands  Include all nested commands in the output.\n\nDESCRIPTION\n  Display help for swanky.\n```\n\n_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v6.0.18/src/commands/help.ts)_\n\n## `swanky init PROJECTNAME`\n\nGenerate a new smart contract environment\n\n```\nUSAGE\n  $ swanky init PROJECTNAME [-v] [--swanky-node] [-t blank|flipper|psp22] [-c \u003cvalue\u003e]\n\nARGUMENTS\n  PROJECTNAME  directory name of new project\n\nFLAGS\n  -c, --convert=\u003cvalue\u003e    Converts an existing smart contract into a Swanky project\n  -t, --template=\u003coption\u003e  \u003coptions: blank|flipper|psp22\u003e\n  -v, --verbose            Display more info in the result logs\n  --swanky-node\n\nDESCRIPTION\n  Generate a new smart contract environment\n```\n\n_See code: [src/commands/init/index.ts](https://github.com/inkdevhub/swanky-cli/blob/v4.0.0/src/commands/init/index.ts)_\n\n## `swanky node chopsticks init`\n\nInitialize chopsticks config\n\n```\nUSAGE\n  $ swanky node chopsticks init [-v]\n\nFLAGS\n  -v, --verbose  Display more info in the result logs\n\nDESCRIPTION\n  Initialize chopsticks config\n```\n\n_See code: [src/commands/node/chopsticks/init.ts](https://github.com/inkdevhub/swanky-cli/blob/v4.0.0/src/commands/node/chopsticks/init.ts)_\n\n## `swanky node chopsticks start`\n\nStart chopsticks\n\n```\nUSAGE\n  $ swanky node chopsticks start [-v] [--config \u003cvalue\u003e]\n\nFLAGS\n  -v, --verbose         Display more info in the result logs\n      --config=\u003cvalue\u003e  Path to the chopsticks config file\n\nDESCRIPTION\n  Start chopsticks\n```\n\n_See code: [src/commands/node/chopsticks/start.ts](https://github.com/inkdevhub/swanky-cli/blob/v4.0.0/src/commands/node/chopsticks/start.ts)_\n\n## `swanky node install`\n\nInstall swanky node binary\n\n```\nUSAGE\n  $ swanky node install [-v] [--set-version \u003cvalue\u003e]\n\nFLAGS\n  -v, --verbose              Display more info in the result logs\n      --set-version=\u003cvalue\u003e  Specify version of swanky node to install.\n                             List of supported versions: 1.7.0, 1.6.0, 1.5.0, 1.4.0, 1.3.0, 1.2.0, 1.1.0, 1.0.0\n\nDESCRIPTION\n  Install swanky node binary\n```\n\n_See code: [src/commands/node/install.ts](https://github.com/inkdevhub/swanky-cli/blob/v4.0.0/src/commands/node/install.ts)_\n\n## `swanky node purge`\n\nPurge local chain state\n\n```\nUSAGE\n  $ swanky node purge [-v]\n\nFLAGS\n  -v, --verbose  Display more info in the result logs\n\nDESCRIPTION\n  Purge local chain state\n```\n\n_See code: [src/commands/node/purge.ts](https://github.com/inkdevhub/swanky-cli/blob/v4.0.0/src/commands/node/purge.ts)_\n\n## `swanky node start`\n\nStart a local node\n\n```\nUSAGE\n  $ swanky node start [-v] [-t] [--rpcCors \u003cvalue\u003e] [--finalizeDelaySec \u003cvalue\u003e]\n\nFLAGS\n  -t, --tmp\n      Run node with non-persistent mode\n\n  -v, --verbose\n      Display more info in the result logs\n\n  --finalizeDelaySec=\u003cvalue\u003e\n      Delay time in seconds after blocks being sealed\n\n  --rpcCors=\u003cvalue\u003e\n      [default: http://localhost:*,http://127.0.0.1:*,https://localhost:*,https://127.0.0.1:*,https://polkadot.js.org,http\n      s://contracts-ui.substrate.io/] RPC CORS origin swanky-node accepts. With '--tmp' flag, node accepts all origins.\n      Without it, you may need to specify by comma separated string.\n      By default, 'http://localhost:*,http://127.0.0.1:*,https://localhost:*,https://127.0.0.1:*,https://polkadot.js.org,h\n      ttps://contracts-ui.substrate.io/' is set.\n\nDESCRIPTION\n  Start a local node\n```\n\n_See code: [src/commands/node/start.ts](https://github.com/inkdevhub/swanky-cli/blob/v4.0.0/src/commands/node/start.ts)_\n\n## `swanky node version`\n\nShow swanky node version\n\n```\nUSAGE\n  $ swanky node version [-v]\n\nFLAGS\n  -v, --verbose  Display more info in the result logs\n\nDESCRIPTION\n  Show swanky node version\n```\n\n_See code: [src/commands/node/version.ts](https://github.com/inkdevhub/swanky-cli/blob/v4.0.0/src/commands/node/version.ts)_\n\n## `swanky plugins`\n\nList installed plugins.\n\n```\nUSAGE\n  $ swanky plugins [--json] [--core]\n\nFLAGS\n  --core  Show core plugins.\n\nGLOBAL FLAGS\n  --json  Format output as json.\n\nDESCRIPTION\n  List installed plugins.\n\nEXAMPLES\n  $ swanky plugins\n```\n\n_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v4.3.5/src/commands/plugins/index.ts)_\n\n## `swanky plugins:install PLUGIN...`\n\nInstalls a plugin into the CLI.\n\n```\nUSAGE\n  $ swanky plugins add plugins:install PLUGIN...\n\nARGUMENTS\n  PLUGIN...  Plugin to install.\n\nFLAGS\n  -f, --force    Run yarn install with force flag.\n  -h, --help     Show CLI help.\n  -s, --silent   Silences yarn output.\n  -v, --verbose  Show verbose yarn output.\n\nGLOBAL FLAGS\n  --json  Format output as json.\n\nDESCRIPTION\n  Installs a plugin into the CLI.\n  Can be installed from npm or a git url.\n\n  Installation of a user-installed plugin will override a core plugin.\n\n  e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command\n  will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in\n  the CLI without the need to patch and update the whole CLI.\n\n\nALIASES\n  $ swanky plugins add\n\nEXAMPLES\n  $ swanky plugins add myplugin \n\n  $ swanky plugins add https://github.com/someuser/someplugin\n\n  $ swanky plugins add someuser/someplugin\n```\n\n## `swanky plugins:inspect PLUGIN...`\n\nDisplays installation properties of a plugin.\n\n```\nUSAGE\n  $ swanky plugins inspect PLUGIN...\n\nARGUMENTS\n  PLUGIN...  [default: .] Plugin to inspect.\n\nFLAGS\n  -h, --help     Show CLI help.\n  -v, --verbose\n\nGLOBAL FLAGS\n  --json  Format output as json.\n\nDESCRIPTION\n  Displays installation properties of a plugin.\n\nEXAMPLES\n  $ swanky plugins inspect myplugin\n```\n\n_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v4.3.5/src/commands/plugins/inspect.ts)_\n\n## `swanky plugins:install PLUGIN...`\n\nInstalls a plugin into the CLI.\n\n```\nUSAGE\n  $ swanky plugins install PLUGIN...\n\nARGUMENTS\n  PLUGIN...  Plugin to install.\n\nFLAGS\n  -f, --force    Run yarn install with force flag.\n  -h, --help     Show CLI help.\n  -s, --silent   Silences yarn output.\n  -v, --verbose  Show verbose yarn output.\n\nGLOBAL FLAGS\n  --json  Format output as json.\n\nDESCRIPTION\n  Installs a plugin into the CLI.\n  Can be installed from npm or a git url.\n\n  Installation of a user-installed plugin will override a core plugin.\n\n  e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command\n  will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in\n  the CLI without the need to patch and update the whole CLI.\n\n\nALIASES\n  $ swanky plugins add\n\nEXAMPLES\n  $ swanky plugins install myplugin \n\n  $ swanky plugins install https://github.com/someuser/someplugin\n\n  $ swanky plugins install someuser/someplugin\n```\n\n_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v4.3.5/src/commands/plugins/install.ts)_\n\n## `swanky plugins:link PLUGIN`\n\nLinks a plugin into the CLI for development.\n\n```\nUSAGE\n  $ swanky plugins link PLUGIN\n\nARGUMENTS\n  PATH  [default: .] path to plugin\n\nFLAGS\n  -h, --help          Show CLI help.\n  -v, --verbose\n      --[no-]install  Install dependencies after linking the plugin.\n\nDESCRIPTION\n  Links a plugin into the CLI for development.\n  Installation of a linked plugin will override a user-installed or core plugin.\n\n  e.g. If you have a user-installed or core plugin that has a 'hello' command, installing a linked plugin with a 'hello'\n  command will override the user-installed or core plugin implementation. This is useful for development work.\n\n\nEXAMPLES\n  $ swanky plugins link myplugin\n```\n\n_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v4.3.5/src/commands/plugins/link.ts)_\n\n## `swanky plugins:uninstall PLUGIN...`\n\nRemoves a plugin from the CLI.\n\n```\nUSAGE\n  $ swanky plugins remove plugins:uninstall PLUGIN...\n\nARGUMENTS\n  PLUGIN...  plugin to uninstall\n\nFLAGS\n  -h, --help     Show CLI help.\n  -v, --verbose\n\nDESCRIPTION\n  Removes a plugin from the CLI.\n\nALIASES\n  $ swanky plugins unlink\n  $ swanky plugins remove\n\nEXAMPLES\n  $ swanky plugins remove myplugin\n```\n\n## `swanky plugins reset`\n\nRemove all user-installed and linked plugins.\n\n```\nUSAGE\n  $ swanky plugins reset [--hard] [--reinstall]\n\nFLAGS\n  --hard       Delete node_modules and package manager related files in addition to uninstalling plugins.\n  --reinstall  Reinstall all plugins after uninstalling.\n```\n\n_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v4.3.5/src/commands/plugins/reset.ts)_\n\n## `swanky plugins:uninstall PLUGIN...`\n\nRemoves a plugin from the CLI.\n\n```\nUSAGE\n  $ swanky plugins uninstall PLUGIN...\n\nARGUMENTS\n  PLUGIN...  plugin to uninstall\n\nFLAGS\n  -h, --help     Show CLI help.\n  -v, --verbose\n\nDESCRIPTION\n  Removes a plugin from the CLI.\n\nALIASES\n  $ swanky plugins unlink\n  $ swanky plugins remove\n\nEXAMPLES\n  $ swanky plugins uninstall myplugin\n```\n\n_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v4.3.5/src/commands/plugins/uninstall.ts)_\n\n## `swanky plugins:uninstall PLUGIN...`\n\nRemoves a plugin from the CLI.\n\n```\nUSAGE\n  $ swanky plugins unlink plugins:uninstall PLUGIN...\n\nARGUMENTS\n  PLUGIN...  plugin to uninstall\n\nFLAGS\n  -h, --help     Show CLI help.\n  -v, --verbose\n\nDESCRIPTION\n  Removes a plugin from the CLI.\n\nALIASES\n  $ swanky plugins unlink\n  $ swanky plugins remove\n\nEXAMPLES\n  $ swanky plugins unlink myplugin\n```\n\n## `swanky plugins update`\n\nUpdate installed plugins.\n\n```\nUSAGE\n  $ swanky plugins update [-h] [-v]\n\nFLAGS\n  -h, --help     Show CLI help.\n  -v, --verbose\n\nDESCRIPTION\n  Update installed plugins.\n```\n\n_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v4.3.5/src/commands/plugins/update.ts)_\n\n## `swanky version`\n\n```\nUSAGE\n  $ swanky version [--json] [--verbose]\n\nFLAGS\n  --verbose  Show additional information about the CLI.\n\nGLOBAL FLAGS\n  --json  Format output as json.\n\nFLAG DESCRIPTIONS\n  --verbose  Show additional information about the CLI.\n\n    Additionally shows the architecture, node version, operating system, and versions of plugins that the CLI is using.\n```\n\n_See code: [@oclif/plugin-version](https://github.com/oclif/plugin-version/blob/v2.0.14/src/commands/version.ts)_\n\n## `swanky zombienet init`\n\nInitialize Zombienet\n\n```\nUSAGE\n  $ swanky zombienet init [-v] [-b polkadot|polkadot-parachain|astar-collator]\n\nFLAGS\n  -b, --binaries=\u003coption\u003e...  Binaries to install\n                              \u003coptions: polkadot|polkadot-parachain|astar-collator\u003e\n  -v, --verbose               Display more info in the result logs\n\nDESCRIPTION\n  Initialize Zombienet\n```\n\n_See code: [src/commands/zombienet/init.ts](https://github.com/inkdevhub/swanky-cli/blob/v4.0.0/src/commands/zombienet/init.ts)_\n\n## `swanky zombienet start`\n\nStart Zombienet\n\n```\nUSAGE\n  $ swanky zombienet start [-v] [-c \u003cvalue\u003e]\n\nFLAGS\n  -c, --config-path=\u003cvalue\u003e  [default: ./zombienet/config/zombienet.config.toml] Path to zombienet config\n  -v, --verbose              Display more info in the result logs\n\nDESCRIPTION\n  Start Zombienet\n```\n\n_See code: [src/commands/zombienet/start.ts](https://github.com/inkdevhub/swanky-cli/blob/v4.0.0/src/commands/zombienet/start.ts)_\n\u003c!-- commandsstop --\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FAstarNetwork%2Fswanky-cli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FAstarNetwork%2Fswanky-cli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FAstarNetwork%2Fswanky-cli/lists"}