Skip to main content
Pre-release

This release is a pre-release and may not be stable for production use.

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:

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

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

create_onchain_agent-0.3.1.dev202503150.tar.gz (6.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

File details

Details for the file create_onchain_agent-0.3.1.dev202503150.tar.gz.

File metadata

File hashes

Hashes for create_onchain_agent-0.3.1.dev202503150.tar.gz
Algorithm Hash digest
SHA256 868f7bab232549abb21fc91c25a2a4c8dec7fa9ad32c931ad02bedf6f7ce0660
MD5 8d1bddfa6a187c54e4412a886876b070
BLAKE2b-256 b37241ac865542929d00155650e842a39ba0ce4aeec432bebd492eccf70268c9

See more details on using hashes here.

File details

Details for the file create_onchain_agent-0.3.1.dev202503150-py3-none-any.whl.

File metadata

File hashes

Hashes for create_onchain_agent-0.3.1.dev202503150-py3-none-any.whl
Algorithm Hash digest
SHA256 4c1fb1e2eaf0c19b938a5504a68e15aa8747f5733a1d4d3f8b554da52779e432
MD5 f6c7a45a25ee75da27a4edc50fe30f24
BLAKE2b-256 a10664820f9c6ba6bb1ee7b9cc90168fc794ec198cfed2c2b36aba5f0f11d665

See more details on using hashes here.

Release history Release notifications | RSS feed

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page