Getting started

The thirdweb CLI is your one-stop-shop for publishing custom contracts for your team or the world to use. The CLI uploads all necessary data to decentralized storage and makes it available to deploy via the thirdweb sdk or thirdweb dashboard.

This brings all the capabilities of thirdweb to your own custom contracts.

Deploying your contract

npx thirdweb@latest deploy

This command will:

• auto-detect any contracts in your project
• compile your project
• Upload ABIs to IPFS
• Open the deploy flow in your thirdweb dashboard in a browser

From the thirdweb dashboard, you can review and deploy your contracts on any supported EVM chain.

Deploying contracts this way gives you access to:

• auto generated SDKs for react, node, python, go
• dashboards to manage, monitor and interact with your contracts

Releasing your contract

npx thirdweb@latest publish

Creates an official published contract, along with:

• author attribution
• contract information
• instructions on how to use and what it's for
• versioning
• release notes

Publishing contracts this way gives you shareable URL to let others deploy your contracts in one click. It lets you manage published versions and get attribution for deployed contracts. Published contracts are registered on-chain (Polygon) and IPFS, for free (gasless).

Deploying published contracts give deployers access to automatic SDKs to integrate into their app and dashboards to manage and monitor the deployed contracts.

Detecting contract extensions

npx thirdweb@latest detect

As you're developing your contracts, you may want to implement Extensions to unlock functionality on the SDKs (ie. nft minting with automatic upload to IPFS) and the dashboard (ie. generated UI to manage permissions). This command will show what extensions were detected on your contract, unlocking the corresponding functionality on the SDKs and dashboard.

Global installation

We recommend using npx to always get the latest version. Alternatively, you can install the CLI as a global command on your machine:

npm i -g @thirdweb-dev/cli

Supported Projects

To publish, you need to be in a directory that contains a project which the CLI is compatible with. The projects we support so far:

• hardhat
• forge
• truffle
• solc

Running the Examples

Clone the repo and run this command after installing the CLI tool:

$ cd examples/hardhat
$ npx thirdweb@latest publish

Local Development

The simplest way to work on the CLI locally is to:

1. Install the package locally by running

git clone https://github.com/thirdweb-dev/js.git

2. From the project root run

pnpm i && pnpm build

3. From inside js/legacy_packages/cli Run the build:watch command to compile any changes in real time

$ npm install -g ./
$ pnpm build:watch