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:
- 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:
- Project Name: The name of your new onchain agent project.
- Package Name: The Python package name (auto-formatted if needed).
- Framework: Choose from available agent frameworks.
- Network: Choose from available blockchain networks.
- Chain ID: Specify if using a custom network.
- 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
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file create_onchain_agent-0.6.0.tar.gz.
File metadata
- Download URL: create_onchain_agent-0.6.0.tar.gz
- Upload date:
- Size: 6.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.12.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
28ace10543b53ad7d172a38d511bdba78782cc7b96723a3f9eaf6694051f5628
|
|
| MD5 |
7a82d2209429da2f4270f248d7b245eb
|
|
| BLAKE2b-256 |
5d533cb3d6887f43f172d6655ec54ac441c5bdc0dc2296ba20599f6bb768a6a6
|
Provenance
The following attestation bundles were made for create_onchain_agent-0.6.0.tar.gz:
Publisher:
publish_pypi_create_onchain_agent.yml on coinbase/agentkit
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
create_onchain_agent-0.6.0.tar.gz -
Subject digest:
28ace10543b53ad7d172a38d511bdba78782cc7b96723a3f9eaf6694051f5628 - Sigstore transparency entry: 213080954
- Sigstore integration time:
-
Permalink:
coinbase/agentkit@366f3b2f6a9c740e930dba806f9bef1333ab7207 -
Branch / Tag:
refs/heads/main - Owner: https://github.com/coinbase
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish_pypi_create_onchain_agent.yml@366f3b2f6a9c740e930dba806f9bef1333ab7207 -
Trigger Event:
workflow_dispatch
-
Statement type:
File details
Details for the file create_onchain_agent-0.6.0-py3-none-any.whl.
File metadata
- Download URL: create_onchain_agent-0.6.0-py3-none-any.whl
- Upload date:
- Size: 6.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.12.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
217eec8ead83eaac916349af552e6b96b0bbfc242f3f248c2ceea71e2736ed6c
|
|
| MD5 |
340064b6bd3232802dc7da066d9598bc
|
|
| BLAKE2b-256 |
c350fb5275fcf377ed963b546ffebc502b1304e07a2f0c22190bdb79f606ca39
|
Provenance
The following attestation bundles were made for create_onchain_agent-0.6.0-py3-none-any.whl:
Publisher:
publish_pypi_create_onchain_agent.yml on coinbase/agentkit
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
create_onchain_agent-0.6.0-py3-none-any.whl -
Subject digest:
217eec8ead83eaac916349af552e6b96b0bbfc242f3f248c2ceea71e2736ed6c - Sigstore transparency entry: 213080957
- Sigstore integration time:
-
Permalink:
coinbase/agentkit@366f3b2f6a9c740e930dba806f9bef1333ab7207 -
Branch / Tag:
refs/heads/main - Owner: https://github.com/coinbase
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish_pypi_create_onchain_agent.yml@366f3b2f6a9c740e930dba806f9bef1333ab7207 -
Trigger Event:
workflow_dispatch
-
Statement type:
