Skip to content

BitteProtocol/make-agent

Repository files navigation

Make Agent CLI

The swiss army knife for multi-chain AI agents

Make Agent CLI is a powerful command-line tool designed to streamline the management and deployment of AI agents across multiple chains. This tool simplifies the process of making your AI agents discoverable and registering them as plugins.

Quick Start:

Read the docs:

https://docs.bitte.ai/agents/quick-start

Next.js Starter project:

https://github.com/BitteProtocol/agent-next-boilerplate

Usage

Running the CLI

To run the Make Agent CLI:

npx make-agent dev -p 3000

Available Commands

Currently, the CLI supports the following command:

  1. dev: Make your AI agent discoverable and register the plugin

    Usage:

    npx make-agent dev -p <port_number>

    Options:

    • -p, --port <number>: Specify the local port to expose (optional).

    If no port is provided, the command will search for a node instance running in the current directory and assume its port.

  2. deploy: Register or update your AI agent, making it discoverable as a plugin

    Usage:

    npx make-agent deploy [options]

    Options:

    • -u, --url <url>: The URL where your agent is hosted (optional)

    If no URL is provided, the command will attempt to determine the URL automatically through environment variables. In particular, see deployed-url.ts for various deployment configurations.

  3. contract: Scaffold a basic agent from a NEAR contract that has an ABI

    Usage:

    npx make-agent contract

    You will be prompted to select a contractId, add a description with instructions on how the agent should use the contract and an output directory

  4. delete: Delete your AI agent plugin

    Usage:

    npx make-agent delete [options]

    Options:

    • -u, --url <url>: Specify the deployment URL (optional)

    If no URL is provided, the command will attempt to determine the deployed URL automatically.

  5. verify: Request your plugin's verification

    Usage:

    npx make-agent verify -u <url> -e <email> -r <repoUrl> -v <versionNumber> -c [cat1,cat2] -x [chainNum1,chainNum2]

    Options:

    • -u, --url <url>: (required) Specify the url of the deployed plugin
    • -e, --email <email>: (required) Provide an email so we can contact you regarding the verification process
    • -r, --repo <repoUrl>: (required) To verify a plugin we need the url for a public repository containing the plugin's code
    • -v, --version <versionNumber>: (optional) Specify the version of the plugin in case of an update
    • -c, --categories <categories>: (optional) List some categories that describe the type of plugin you're verifying.
    • -x, --chains <chainIds>: (optional) If your plugin works on specific evm chains, you can specify them so your plugin is easier to find.

    These options can also be defined in the agent spec in the "x-mb" object.

Development

Install dependencies

pnpm install

# Develop agents locally
pnpm run dev

# Deploy agents
pnpm make-agent deploy

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.