CLI
The CLI provides tools to create, build, and deploy projects using thirdweb tools and infrastructure. Using the CLI, you can create new projects with the SDK configured, build, publish and deploy smart contracts, generate types while developing, upload files to IPFS, and more.
Open Source
The CLI is open-source. You can view the source code and contribute to it on GitHub.
Installation
Install the CLI package globally to use the commands anywhere on your system.
Note: If you do not wish to install it globally, you can prefix each command with npx
. i.e. npx thirdweb <command>
.
- npm
- yarn
- pnpm
npm i -g @thirdweb-dev/cli
yarn global add @thirdweb-dev/cli
pnpm install -g @thirdweb-dev/cli
Once installed, you can view the full list of available commands by running:
thirdweb
Available Commands
Name of command | Description |
---|---|
create | Create a web3 app from any of our official templates. |
install | Add thirdweb’s packages to your existing project. |
build | Compile contract and detect thirdweb contract extensions. |
generate | Fetch contract ABIs and generate types for the SDK and improve performance. |
upload | Upload any file or directory to decentralized storage (IPFS). |
deploy | Deploy your (or your team's) contracts securely to blockchains. |
publish | Publish your protocol so other devs can deploy them and unlock SDKs, dashboards and analytics. |