cannon

Guide Ethereum contract testing, deployment, and publishing with the Cannon CLI.

125|29|Updated Jul 12, 2022
One-click install
npx skills add https://github.com/usecannon/cannon --skill cannon-usecannon
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: cannon
Source: https://github.com/usecannon/cannon/tree/main/packages/skill
Command: npx skills add https://github.com/usecannon/cannon --skill cannon-usecannon

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

Cannon package managers and deployment workflows are complex and easy to get wrong, especially when commands are irreversible or depend on chain-specific parameters. The cannon skill helps reduce mistakes by guiding correct usage of Cannon’s CLI, cannonfile syntax, and deployment/publishing workflows with explicit safety guardrails.

Core Features & Use Cases

  • CLI guidance for real workflows: Build, run, test, inspect, publish, verify, and decode/trace/deploy operations with the correct flags and expectations.
  • Cannonfile specification support: Explain and validate cannonfile.toml structure, variables, templates, and action types (deploy, invoke, clone, import/pull, router, diamond, var).
  • Deployment safety and debugging: Enforce dry-run-first behavior, help with common troubleshooting (wrong chain, missing artifacts, IPFS/registry issues), and suggest local testing patterns (chain 13370).

Quick Start

Ask the AI to create a safe dry-run deployment plan for a specific cannonfile and explain exactly what will change before you run the real cannon build.

Frequently Asked Questions about cannon

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I safely deploy Ethereum smart contracts without making irreversible mistakes?

Safely deploy Ethereum smart contracts by generating a dry-run deployment plan using a cannonfile to preview exact on-chain changes before executing the real build command. This enforces irreversible-action guardrails to prevent costly mistakes.

What is a cannonfile and how does it map to on-chain contract deployment?

A cannonfile is a TOML specification that defines deployment actions like deploy, invoke, clone, and router for Ethereum packages. It maps templates and variables directly to intended on-chain outcomes during contract testing and publishing.

How do I verify deployed Ethereum contracts and inspect decoded artifacts?

Verify deployed Ethereum contracts and inspect decoded artifacts by running specific Cannon CLI commands designed for tracing and decoding deployment outputs. This provides explicit safety guardrails and validates correct contract verification workflows.

Why is my Ethereum package deployment failing due to wrong chain or missing artifacts?

Ethereum package deployment fails due to wrong chain parameters, missing artifacts, or IPFS and registry issues. Troubleshoot by enforcing local testing patterns on chain 13370 and validating your cannonfile structure before running operations.

Does Cannon CLI support GitOps workflows and automated package migrations?

Cannon CLI supports GitOps workflows and automated package migrations by guiding correct build, run, and publish operations using the cannonfile specification. It ensures correct command flags and chain-specific parameters are applied.

How do I test Ethereum contract deployment locally before publishing to a registry?

Test Ethereum contract deployment locally by running Cannon CLI tests with deployment context on local chain 13370. This dry-run-first behavior validates your cannonfile actions and templates before executing irreversible publish operations.