Skip to main content

CLI to create an onchain agent project

Project description

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

Project details


Release history Release notifications | RSS feed

This version

0.9.0

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.9.0.tar.gz (7.6 kB view details)

Uploaded Source

Built Distribution

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

create_onchain_agent-0.9.0-py3-none-any.whl (7.5 kB view details)

Uploaded Python 3

File details

Details for the file create_onchain_agent-0.9.0.tar.gz.

File metadata

  • Download URL: create_onchain_agent-0.9.0.tar.gz
  • Upload date:
  • Size: 7.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for create_onchain_agent-0.9.0.tar.gz
Algorithm Hash digest
SHA256 ccbf421ecae41b38c8bc8c4b7d5b518f818515896026353886909353c68e0b3f
MD5 a84057a08bf755f5bc819227b684f4f2
BLAKE2b-256 a147bff36399acae3af5fce21064c8367e0e8575e3cdafee8c4c04d2b64ab23a

See more details on using hashes here.

Provenance

The following attestation bundles were made for create_onchain_agent-0.9.0.tar.gz:

Publisher: publish_pypi_create_onchain_agent.yml on coinbase/agentkit

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file create_onchain_agent-0.9.0-py3-none-any.whl.

File metadata

File hashes

Hashes for create_onchain_agent-0.9.0-py3-none-any.whl
Algorithm Hash digest
SHA256 995ef919ca1030d03e5712c36dc3efd259af976218f56fb3d1f578ec1b736c8e
MD5 57b8701b802af580ef12668d1107d9e2
BLAKE2b-256 84f662bb61c042bcba071b8f1a91110aa889e3ad850ea792f8e541556e2576a7

See more details on using hashes here.

Provenance

The following attestation bundles were made for create_onchain_agent-0.9.0-py3-none-any.whl:

Publisher: publish_pypi_create_onchain_agent.yml on coinbase/agentkit

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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