Usage Overview¶

Auto Dev provides a comprehensive set of tools for automating development tasks. This guide will help you understand how to use the main features effectively.

Basic Usage¶

The basic command structure is:

adev <command> [options] [arguments]

For example:

# Create a new project
adev create my-project

# Run development tasks
adev run

# Format code
adev fmt

Common Workflows¶

1. Starting a New Project¶

# Create a new project
adev repo scaffold my-project

# Change to project directory
cd my-project

# Initialize git repository
 adev create -t eightballer/frontend_agent new_author/new_agent --no-clean-up



# Set up development environment
adev scaffold

2. Development Workflow¶

# Format code
adev fmt

# Run linting
adev lint

# Run tests
adev test

Advanced Features¶

For more advanced features, check out: - FSM for Finite State Machine functionality - OpenAPI for API development tools

Getting Help¶

You can get help for any command using the --help flag:

adev --help
adev <command> --help

Installation¶

Note: Python version 3.11 or higher is required.

To use auto_dev in a project, first install it via pip:

pip install autonomy-dev[all]

or if you are on bash

pip install 'autonomy-dev[all]'

Basic Commands¶

Repository and Agent Creation¶

Create a new repository and agent:

# Create a new repository
adev repo scaffold fun_new_hack

# Navigate to the repository
cd fun_new_hack

# Create an agent using a template
adev create author/cool_agent --template eightballer/frontend_agent

# Optional: Sync to local registry
yes 'third_party' | autonomy packages lock

adev run author/cool_agent

Development Tools¶

Auto_dev provides several development utilities:

Linting
```
adev lint
```
Formatting
```
adev fmt
```
Dependency Management
```
adev deps update
```

Component Scaffolding¶

Protocol Generation¶

Generate protocol components from specifications:

# Create a base agent first
adev create author/tmp_agent_name -t eightballer/base --force

# Navigate to agent directory
cd tmp_agent_name

# Scaffold protocol from spec file
adev scaffold protocol ../specs/protocols/balances.yaml 

# Publish the protocol
aea -s publish --push-missing

# Run tests for the protocol
adev test -p packages/eightballer/protocols/balances

Contract Scaffolding¶

Generate smart contract components from deployed contracts:

# Basic usage

# Create a new repository
adev repo scaffold fun_new_hack

# Navigate to the repository
cd fun_new_hack

# Create an agent using a template
adev create author/cool_agent --template eightballer/frontend_agent --no-clean-up

cd cool_agent

adev scaffold contract author/some_contract --address <CONTRACT_ADDRESS> --network <NETWORK_NAME>

# Example: Scaffold USDC contract from Base network
adev scaffold contract author/usdc --address 0x833589fcd6edb6e08f4c7c
32d4f71b54bda02913 --network base

# Advanced usage with local ABI
adev scaffold contract author/my_contract \
    --from-abi ./path/to/abi.json \



# Specify specific functions to include from a file (TODO)
adev scaffold contract author/my_contract \
    --address  0x833589fcd6edb6e08f4c7c32d4f71b54bda02913 \
    --read-functions "balanceOf,totalSupply" \
    --write-functions "transfer,approve" \
    --network base

Release Process¶

To create a new release:

# Ensure you're on main branch
checkout main
git pull

# Create release
adev release