Skip to main content
This guide shows the commands you need to initialize, build, and deploy a Web3 Action project using Tenderly CLI. Step 1: Install the Tenderly CLI Use the curl command to download and install the Tenderly CLI binary on your local machine. Install on macOS:
example
Install on Linux:
example
Step 2: Log in to Tenderly via the CLI Log into the Tenderly CLI with your credentials by running this command:
example
Step 3: Initialize a Web3 Actions project To initialize a Web3 Action project, run this command:
example
You can change the default initialization settings with three flags: --sources sets the name of the root Web3 Actions folder (default: actions), --language sets the language for writing Action functions (typescript, the default, or javascript), and --template initializes the project from a starter template in the Tenderly/tenderly-actions repository.
example
You’ll be prompted to add your Web3 Actions to a Tenderly project. You can either create a new project or pick an existing one. Step 3: Install any NPM dependency you need After running tenderly actions init, you have an NPM project at your disposal, so you can install any NPM library you need in a familiar way.
example
Step 4: Build and deploy Web3 Actions After you have written your function and trigger configuration in tenderly.yaml, you can run these commands to build and deploy the Web3 Action.
example
Shortly after running deploy, your Web3 Action is available in the Dashboard and listening to events per your configuration. A publish-ed action is visible in the Dashboard but stays inactive: it isn’t scheduled and doesn’t listen to events until you run deploy or start it from the Dashboard.
You can upgrade your Web3 Actions with zero downtime, by running the deploy command after you’ve edited the function and trigger configuration.
Optional: Validate your tenderly.yaml Before deploying, you can validate the structure and trigger configuration of your tenderly.yaml locally. No login is required.
example
The --json flag emits a structured result. When everything is valid:
When validation fails, schema_errors and/or trigger_errors are included (omitted when empty):
Optional: Generate a JSON Schema for your editor The schema command outputs a JSON Schema describing the actions section of tenderly.yaml. Use it with the VS Code YAML extension (redhat.vscode-yaml) or JetBrains IDEs to get autocomplete and validation while editing the file.
example
Optional: Explore supported features To see a machine-readable manifest of all supported trigger types, runtimes, execution types, and intervals:
example
This is useful for editor integrations and tooling that need to discover what the CLI supports without parsing documentation. Optional: Using Tenderly Runtime locally Install the @tenderly/actions-test package to test your Web3 Action Functions locally. Assuming you’re already in an npm project, run the following:
example
It’s recommended to keep tests and run scripts for web3-actions outside of the actions directory, to avoid increasing the size of your Web3 Actions project.
Check out a guide on local development and testing of Web3 Actions for more detail and examples.