Tenderly CLI is a suite of development tools that allows you to debug, monitor and track the execution of your smart contracts.
You can install the Tenderly CLI via the Homebrew package manager:
brew tap tenderly/tenderly
brew install tenderly
Or if you prefer you can also install by using cURL and running our installation script:
curl https://raw.githubusercontent.com/Tenderly/tenderly-cli/master/scripts/install-macos.sh | sh
You can install the Tenderly CLI by using cURL and running our installation script.
With root privileges user:
curl https://raw.githubusercontent.com/Tenderly/tenderly-cli/master/scripts/install-linux.sh | sh
Or with sudo user:
curl https://raw.githubusercontent.com/Tenderly/tenderly-cli/master/scripts/install-linux.sh | sudo sh
Go to the release page, download the latest version and put it
somewhere in your $PATH.
You can check the current version of the CLI by running:
tenderly version
To upgrade it via Homebrew:
brew upgrade tenderly
The login command is used to authenticate the Tenderly CLI with
your Tenderly Dashboard.
tenderly login
| Flag | Default | Description |
|---|---|---|
| --authentication-method | / | Pick the authentication method. Possible values are email or access-key |
| / | The email used when authentication method is email | |
| --password | / | The password used when authentication method is email |
| --access-key | / | The token used when authentication method is access-key |
| --force | false | Don't check if you are already logged in |
| --help | / | Help for login command |
The init command is used to connect your local project directory with a project in
the Tenderly Dashboard.
tenderly init
| Flag | Default | Description |
|---|---|---|
| --project | / | The project name used for generating the configuration file |
| --create-project | false | Creates the project provided by the --project flag if it doesn't exist |
| --re-init | false | Force initializes the project if it was already initialized |
| --help | / | Help for init command |
For Tenderly CLI to work you need to have a deployments directory inside your project. You can generate that one
using hardhat-tenderly
- To install hardhat-tenderly run.
npm install --save-dev @tenderly/hardhat-tenderly- Add the following statement to your
hardhat.config.js:
require("@tenderly/hardhat-tenderly");Or, if you are using typescript:
import "@tenderly/hardhat-tenderly"- Then you need to call it from your scripts (using ethers to deploy a contract):
const Greeter = await ethers.getContractFactory("Greeter");
const greeter = await Greeter.deploy("Hello, Hardhat!");
await greeter.deployed()
await hre.tenderly.persistArtifacts({
name: "Greeter",
address: greeter.address,
})persistArtifacts accept variadic parameters:
const contracts = [
{
name: "Greeter",
address: "123"
},
{
name: "Greeter2",
address: "456"
}
]
await hre.tenderly.persistArtifacts(...contracts)- Run:
npx hardhat compileto compile contracts - Run:
npx hardhat node --network hardhatto start a local node - Run:
npx hardhat run scripts/sample-script.js --network localhostto run a script - And at the end now when
deploymentsdirectory was built you can runtenderly init
If you are using Hardhat, take a look at docs instead of using this command.
The push command is used to add your contracts to the Tenderly Dashboard.
Note that the push command is used only for adding contracts that are deployed to a public network. For local
networks see the export command.
tenderly push
| Flag | Default | Description |
|---|---|---|
| --networks | / | A comma separated list of network ids to push |
| --tag | / | Optional tag used for filtering and referencing pushed contracts |
| --project-slug | / | Optional project slug used to pick only one project to push (see advanced usage) |
| --help | / | Help for push command |
It is possible to push to multiple projects by editing the tenderly.yaml file and providing a map of projects and
their networks. To do this remove the already provided project_slug property and replace it with the projects
property like the example below;
projects: # running tenderly push will push the smart contracts to all of the provided projects
my-cool-project:
networks:
- "1" # mainnet
- "42" # kovan
my-other-project:
# if the networks property is not provided or is empty the project will be pushed to all of the migrated networks
company-account/my-other-project:
# if you want to push to a shared project provide the full project identifier
# the identifier can be found in your Tenderly dashboard under the projects nameIn order to use the tenderly export command you need to define a configuration file (which is described in more detail in the export command advanced usage section).
tenderly export init
| Flag | Default | Description |
|---|---|---|
| --project | / | The project name used for network configuration |
| --rpc | / | Rpc server address (example: 127.0.0.1:8545) |
| --forked-network | / | In case you forked a public network (example: mainnet) |
| --help | / | Help for export init command |
The export command can be used to access transaction debugging tooling available at https://dashboard.tenderly.co/ but
for local transactions.
Use the Transaction Overview , Human-Readable Stack-Traces , Debugger , Gas Profiler , Decoded Events and State to boost your local development productivity.
tenderly export {{transaction_hash}}
| Name | Description |
|---|---|
| transaction hash | Hash of the local transaction to debug |
| Flag | Default | Description |
|---|---|---|
| --export-network | / | The name of the exported network in the configuration file |
| --project | / | The project in which the exported transactions will be stored |
| --rpc | 127.0.0.1:8545 | The address and port of the local rpc node |
| --forked-network | / | Optional name of the network which you are forking locally. Can be one of Mainnet, Goerli, Kovan, Ropsten, Rinkeby, xDai |
| --protocol | / | Specify the protocol used for the rpc node. By default wss, https, ws, http are tried in that order |
| --help | / | Help for export command |
| --force | false | Export the transaction regardless of gas mismatch |
If your local node has different blocks defined for hardforks or you want to generate the configuration file yourself, you can find the example bellow:
exports: # running tenderly export will export local transaction to the provided project
my-network:
project_slug: my-cool-project
rpc_address: 127.0.0.1:8545
protocol: http
forked_network: mainnet
chain_config:
homestead_block: 0 # (default 0)
eip150_block: 0 # (default 0)
eip150_hash: 0x0 # (default 0x0)
eip155_block: 0 # (default 0)
eip158_block: 0 # (default 0)
byzantium_block: 0 # (default 0)
constantinople_block: 0 # (default 0)
petersburg_block: 0 # (default 0)
istanbul_block: 0 # (default 0)
berlin_block: 0 # (default 0)
london_block: 0 # (default 0)
my-company-network:
project_slug: company-account/my-other-project
rpc_address: rpc.ethereum.company:8545
# if you want to export to a shared project provide the full project identifier
# the identifier can be found in your Tenderly dashboard under the projects nameThe verify command uploads your smart contracts and verifies them on Tenderly.
tenderly verify
| Flag | Default | Description |
|---|---|---|
| --networks | / | A comma separated list of network ids to verify |
| --help | / | Help for verify command |
The update-check command checks if there is a new version of the Tenderly CLI and gives update instructions and
changelog information.
The version command prints out the current version of the Tenderly CLI.
tenderly version
The whoami command prints out basic information about the currently logged in account
tenderly whoami
The logout command disconnects your local Tenderly CLI from your Tenderly Dashboard
tenderly logout
The proxy command is deprecated in favor of the export command.
In addition to command specific flags, the following flags can be passed to any command
| Flag | Default | Description |
|---|---|---|
| --debug | false | Turn on debug level logging |
| --output | text | Which output mode to use: text or json. If not provided. text output will be used. |
| --global-config | config | Global configuration file name (without the extension) |
| --project-config | tenderly | Project configuration file name (without the extension) |
| --project-dir | "./" | The directory in which your Truffle project resides |
We look forward to any feedback you want to share with us or if you're stuck with a problem you can contact us at support@tenderly.co.
Made with ♥ by Tenderly