tenderly.yaml file is the project-level configuration file that connects your local project to Tenderly. It’s created in your project directory when you run tenderly init.
File Location
The file is located at the root of your project directory:Basic Configuration
A basictenderly.yaml file contains your account ID, project slug, and provider information:
Configuration Fields
Your Tenderly account ID. Set automatically when you run
tenderly init.The slug of your Tenderly project. For shared/organization projects, use the format
organization-name/project-slug.The development framework provider. Supported values:
hardhattrufflebuidlerbrownieopenzeppelin
Configuration for pushing contracts to multiple projects. See Multiple Projects for details.
Multi-Project Configuration
You can configure multiple projects in a singletenderly.yaml file. This is useful when you want to push the same contracts to different projects or networks:
When using the
projects field, remove the project_slug field from your configuration.Network IDs
When specifying networks in your configuration, use the chain ID as a string:| Network | Chain ID |
|---|---|
| Ethereum Mainnet | ”1” |
| Goerli | ”5” |
| Sepolia | ”11155111” |
| Polygon | ”137” |
| Optimism | ”10” |
| Arbitrum | ”42161” |
| Base | ”8453” |
Example Configurations
Single Project with Hardhat
Single Project with Hardhat
Multiple Projects with Network Filtering
Multiple Projects with Network Filtering
Organization Shared Project
Organization Shared Project
File Management
The
tenderly.yaml file should be committed to version control so your team can share the same project configuration.Regenerating Configuration
If you need to reinitialize your project configuration:tenderly.yaml file.
Custom Configuration Name
You can use a custom name for your project configuration file:custom-config.yaml instead of tenderly.yaml.
Related Configuration
- Global Config: See
~/.tenderly/config.yamlfor authentication tokens and global settings - Actions: Use
tenderly actions initto add action configurations totenderly.yaml - Extensions: Use
tenderly node-extensions initto add node extension configurations
Common Issues
Project not initialized error
Project not initialized error
If you see “You need to initiate the project first”, ensure:
- The
tenderly.yamlfile exists in your project directory - The file contains either a
project_slugorprojectsfield - You’re running commands from the correct directory
--project-dir flag to specify a different directory:Provider not detected
Provider not detected
If the provider isn’t detected automatically:
- Ensure your project has the necessary configuration files (
hardhat.config.js,truffle-config.js, etc.) - Use the
--forceflag to skip provider detection - Manually set the
providerfield intenderly.yaml
See Also
- Global Flags - Command-line flags that work with all commands
- Multiple Projects - Detailed guide for multi-project setups
- tenderly init - Initialize your project
- tenderly push - Push contracts to Tenderly