create-onchain-agent 0.3.1.dev202503160

CLI to create an onchain agent project

create-onchain-agent

Overview

create-onchain-agent is a CLI tool powered by AgentKit that allows developers to quickly scaffold an onchain agent project. This tool simplifies the setup process by generating a chatbot with predefined configurations, including blockchain network selection and wallet providers.

Requirements

To use create-onchain-agent, you must first setup:

• Python: Install Python version 3.10 or 3.11
• Pipx: Install pipx using Python version 3.10 or 3.11

NOTE: If you have multiple versions of Python installed, you can specify the Python version when installing pipx.

e.g.:

python3.10 -m pip install --user pipx
python3.10 -m pipx ensurepath

Usage

To use create-onchain-agent, simply run:

pipx run create-onchain-agent

This command will guide you through setting up an onchain agent project by prompting for necessary configuration options.

Beginner Mode

If you are a beginner to web3 agents, we recommend running the command with the beginner flag:

pipx run create-onchain-agent --beginner

This will create a simplified chatbot with our recommended configurations, so you can get started quickly, without having to worry about the underlying details.

Features

• Guided setup: Interactive prompts help configure the project.
• Supports multiple agent frameworks.
• Supports multiple blockchain networks.
• Select your preferred wallet provider.
• Automates environment setup.

Setup Process

The CLI will prompt you for the following details:

1. Project Name: The name of your new onchain agent project.
2. Package Name: The Python package name (auto-formatted if needed).
3. Framework: Choose from available agent frameworks.
4. Network: Choose from available blockchain networks.
5. Chain ID: Specify if using a custom network.
6. Wallet Provider: Select a preferred method for wallet management.

After answering the prompts, the CLI will:

• Generate the project structure.
• Copy necessary template files.
• Configure the selected settings.
• Display next steps to get started.

Getting Started

Once your project is created, navigate into the directory and install dependencies:

cd my-project
poetry install

Then, configure your environment variables:

mv .env.local .env

Run the chatbot:

poetry run python chatbot.py

Documentation & Support

• Docs: https://docs.cdp.coinbase.com/agentkit/docs/welcome
• GitHub Repo: http://github.com/coinbase/agentkit
• Community & Support: https://discord.gg/CDP