Quick Start

How to get started in 3 minutes creating an Open Agent.

In this guide we will:

1. Pick and fork an Open Agent template from Bitte Templates.

2. Install the make-agent CLI tool and add it to the NextJS template.

3. Develop the Open Agent locally against Bitte Wallet.

4. Deploy your agent and go live!

1. Clone agent template

Bitte Next Agent Template

To get started with your Open Agent project, first clone the Bitte Next Agent Template repository. You can use this ready-to-use template as a solid foundation for building your agent

2. Install make-agent

make-agent is a CLI tool that was built to make the development of an Open Agent as easy as possible. It takes care of API keys management, connecting your agent to the wallet for testing purposes and even making your agent live when you're ready.

The templates should have these packages installed. But if you're trying to add this to an existing project, please install make-agent and concurrently.

npm

npm i -D make-agent concurrently

pnpm

pnpm i -D make-agent concurrently

bun

bun add -D make-agent concurrently

Your package.json should look like this:

  "scripts": {
    "dev": "concurrently \"next dev\" \"make-agent dev --port 3000\"",
    "build": "next build && make-agent deploy",
    "start": "next start",
    "lint": "next lint"
  },

You can now run in development mode.

npm

npm run dev

pnpm

pnpm run dev

bun

bun run dev

Notes for Brave Users

If you're using Brave browser, please be aware that you'll need to turn off Shields when working with the agent quickstart. Otherwise, the "Sign in with Bitte" step for the make-agent tool will be blocked by the Brave browser's built-in protections.

To avoid any interruptions, simply toggle Shields off for this site, and everything should work smoothly.

3. Test against the Bitte Wallet

The first time you run make-agent in your project, you'll notice that it prompts you to sign a message and then write an entry in your .env file under BITTE_KEY. This is the API key creation process and a needed step to validate your updates from now on. By deleting this value and running make-agent again will prompt to sign the message again.

After a successful wallet signature, your agent should be live and well. It is now running in development mode, and the playground page should boot up and you can now edit your files locally and test the changes live in the wallet.

Note that we've attributed an Agent ID to your agent. This is an ephemeral public URL without the protocol scheme (see fruity-lemons-happen.loca.lt).

Bitte Wallet AI Runtime will communicate with your development instance via the corresponding URL.

Our wallet knows how to communicate with your local agent due to the manifest file that explains its capabilities. Your manifest can be accessed in /well-known/ai-plugin.json. In this demo's case it would have been https://fruity-lemons-happen.loca.lt/.well-known/ai-plugin.json

Once you stop your development server, this will be taken down and no longer be accessible.

4. Go live!

Consider pushing your code to its own GitHub repository and hosting it in a easy to deploy service like Vercel. There are other alternatives, but we find Vercel very easy to work with.

DO NOT FORGET to add your Bitte Key to the environment variables.

BITTE_KEY=<YOUR_GENERATE_KEY>

Once that's done, you can trigger a deployment or it happens automatically once you merge to your main branch.

Note that your deploy script includes make-agent deploy. This command will validate your API key, look into the deployment URL (for most common hosting providers) and automatically communicate any changes made to our registry.

In case you want to have more control over your deployment URL, you can set BITTE_AGENT_URL

BITTE_AGENT_URL=<YOUR_DESIRED_URL>

---

Learn more about the Manifest file by following the link below.

Manifest