This template is a boilerplate App for Maven AGI, which allows developers to add additional capabilities to an agent running on Maven AGI. There are several types of available APIs, including the ask API for making conversational requests, APIs for ingesting knowledge and user data for personalization, plus event listeners for important agent events. See our developer documentation for more info.

All capabililties are installed into Maven AGI on app installation in src/index.ts.

• Experience - see src/app/page.tsx
• Knowledge - see src/lib/knowledge.ts
• Actions - see src/lib/actions.ts
• TODO Personalization - see src/lib/users.ts
• TODO Triggers - see src/app/api/routes.ts

First, install the project dependencies:

% pnpm install

Run the development server:

% pnpm dev

Open http://localhost:3000 with your browser to see the result. Use curl -X POST http://localhost:3000/api to exercise the api route.

This App template uses conventional commits to drive semantic versioning. Commits are linted and git-cz is installed to help create quality commit messages. To run:

% pnpm cz

1. Set the template as a remote for your repo: git remote add template https://github.com/mavenagi-apps/template.git
2. git fetch all
3. git merge template/main --allow-unrelated-histories

Note that you will most likely have merge conflicts for all the existing template files that you have touched; resolving those boils down to always keeping your current changes and ignore incoming changes.

For instructions on installing on an agent, see our product documentation