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.

CLI

CLI is open-source; view and contribute to its source code on GitHub.

View on GitHub

Installation

Usage on Windows

If you are on windows, please avoid using powershell it has some known issues that we are actively working on, please use git bash instead or the windows command prompt.

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 i -g thirdweb

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 to generate types and improve performance in the SDK.
`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.
`login`	Authenticate with the thirdweb CLI using your API secret key or replace an existing API key.
`logout`	Logout of the thirdweb CLI, effectively removing your API secret key from your machine.