Skip to main content

Command List

This page provides a comprehensive reference of all commands available in the Tenderly CLI.

Global Commands

tenderly

The root command for the Tenderly CLI.
tenderly [command]
Description: Tenderly CLI is a suite of development tools for smart contracts which allows you to monitor and debug them on any network.
--debug
boolean
default:"false"
Turn on debug level logging
--output
string
default:"text"
Output mode: text or json
--reset-provider
boolean
default:"false"
Clear set deployment provider. If not provided, will use provider from tenderly.yaml
--global-config
string
default:"config"
Global configuration file name (without the extension)
--project-config
string
default:"tenderly"
Project configuration file name (without the extension)
--project-dir
string
default:"."
The directory in which your Truffle project resides

Authentication Commands

login

Authenticate with your Tenderly account.
tenderly login [flags]
Description: Authenticate using email/password or access key to use Tenderly services.
--email
string
The email used for logging in
--password
string
The password used for logging in
--access-key
string
The access key generated in your Tenderly dashboard at https://dashboard.tenderly.co/account/authorization
--authentication-method
string
Pick the authentication method: email or access-key
--force
boolean
default:"false"
Don’t check if you are already logged in
tenderly login --authentication-method email

logout

Log out of the currently logged in Tenderly account.
tenderly logout
Description: Logs you out by clearing stored authentication tokens.

whoami

Display information about the currently logged in user.
tenderly whoami
Description: Shows your user ID, email/organization name, and username.

Project Commands

init

Initialize Tenderly CLI for a project.
tenderly init [flags]
Description: Set up a Tenderly project in the current directory by creating a tenderly.yaml configuration file.
--project
string
The project name to use for generating the configuration file
--create-project
boolean
default:"false"
Creates the project provided by the —project flag if it doesn’t exist
--re-init
boolean
default:"false"
Force initializes the project if it was already initialized
--force
boolean
default:"false"
Don’t check if the project directory contains the expected directory structure

Contract Commands

contracts

Manage smart contracts in your Tenderly project.
tenderly contracts [command]
Available Commands:
  • push - Push contracts to Tenderly
  • verify - Verify contracts on Tenderly
  • remove - Remove contracts from project

contracts push

Push contracts to your Tenderly project for monitoring.
tenderly contracts push [flags]
Description: Uploads contracts from your build directory to Tenderly. After contracts are pushed, they are actively monitored.
--tag
string
Optional tag used for filtering and referencing pushed contracts
--networks
string
A comma-separated list of network IDs to push
--project-slug
string
The slug of a project you wish to push to
tenderly contracts push

contracts verify

Verify all project contracts on Tenderly.
tenderly contracts verify [flags]
Description: Verifies smart contracts on Tenderly without monitoring them.
--networks
string
A comma-separated list of network IDs to verify

contracts remove

Remove contracts from your Tenderly project.
tenderly contracts remove [flags]
Description: Remove contracts from your project by tag or contract ID.
--tag
string
Remove all contracts with matched tag from configured project
--id
string
Remove contract with specific ID (format: “eth::”)
--project-slug
string
The slug of a project you wish to remove contracts from

Web3 Actions Commands

actions

Create, build and deploy Web3 Actions.
tenderly actions [command]
Description: Web3 Actions run your code in response to on-chain or off-chain events on your smart contracts. Available Commands:
  • init - Initialize actions project
  • build - Build actions for project
  • publish - Publish actions to dashboard
  • deploy - Deploy and activate actions

actions init

Initialize a new Web3 Actions project.
tenderly actions init [flags]
Description: Guides you through setting up an actions project. Populates sources directory and creates configuration in tenderly.yaml.
--project
string
The project slug in which the actions will be published & deployed
--sources
string
The path where the actions will be created
--language
string
default:"typescript"
Initialize actions for this language. Supported: javascript, typescript
--template
string
Initialize actions from a template (see Tenderly/tenderly-actions)

actions build

Build actions for your project.
tenderly actions build
Description: Validate configuration and build implementation without deploying. Useful for testing before deployment.

actions publish

Publish actions to the dashboard.
tenderly actions publish
Description: Upload actions to the Tenderly dashboard without deploying or activating them.

actions deploy

Deploy and activate actions.
tenderly actions deploy
Description: Deploy actions to production. Deployed actions will be scheduled according to their configured triggers.

Node Extensions Commands

node-extensions

Create, build and deploy Node Extensions.
tenderly node-extensions [command]
Description: Node Extensions allow you to build and deploy custom RPC endpoints for your dapps. Backed by Web3 Actions. Available Commands:
  • init - Initialize node extensions
  • deploy - Deploy extensions

node-extensions init

Initialize node extensions for your project.
tenderly node-extensions init [flags]
Description: Guides you through setting up extensions in your project. Populates the node_extensions section in tenderly.yaml.
--name
string
Name for the extension
--description
string
Description for the extension
--methodName
string
Name for the extension method (must begin with “extension_“)

node-extensions deploy

Deploy extensions for your project.
tenderly node-extensions deploy [flags]
Description: Deploys the extension specified in command arguments.
--account
string
The account slug in which the extension will be deployed
--project
string
The project slug in which the extension will be deployed
--extensionName
string
Name of the extension to deploy

DevNet Commands

devnet

Tenderly DevNets commands.
tenderly devnet [command]
Description: Manage Tenderly DevNets for development and testing. Available Commands:
  • spawn-rpc - Spawn a DevNet RPC endpoint

devnet spawn-rpc

Spawn a DevNet RPC endpoint.
tenderly devnet spawn-rpc [flags]
Description: Create a JSON-RPC endpoint for your DevNet.
--account
string
The Tenderly account username or organization slug. If not provided, reads from tenderly.yaml
--project
string
The DevNet project slug. If not provided, reads from tenderly.yaml
--template
string
required
The DevNet template slug to apply when spawning the DevNet RPC
--access_key
string
The Tenderly access key. If not provided, reads from config
--token
string
The Tenderly JWT token. If not provided, reads from config
--return-url
boolean
default:"false"
Return the URL instead of printing it

Utility Commands

version

Display the Tenderly CLI version.
tenderly version
Description: Shows the current CLI version and provides information for reporting bugs.

export (Deprecated)

The export feature has been deprecated.
tenderly export
Description: This feature has been replaced by DevNets. Use DevNets for development node infrastructure.

Legacy Commands

The following commands are deprecated. Use the new contracts subcommands instead.

push (Deprecated)

tenderly push [flags]
Replacement: Use tenderly contracts push instead.

verify (Deprecated)

tenderly verify [flags]
Replacement: Use tenderly contracts verify instead.

Build docs developers (and LLMs) love