default-template-example

A new Agentuity project created with agentuity create.

What You Get

A fully configured Agentuity project with:

• ✅ TypeScript - Full type safety out of the box
• ✅ Bun runtime - Fast JavaScript runtime and package manager
• ✅ Hot reload - Development server with auto-rebuild
• ✅ Example agent - Sample "hello" agent to get started
• ✅ React frontend - Pre-configured web interface
• ✅ API routes - Example API endpoints
• ✅ Type checking - TypeScript configuration ready to go

Project Structure

my-app/
├── src/
│   ├── agent/            # Agent definitions
│   │   └── hello/
│   │       ├── agent.ts  # Example agent
│   │       └── index.ts  # Default exports
│   ├── api/              # API definitions
│   │   └── index.ts      # Example routes
│   └── web/              # React web application
│       ├── public/       # Static assets
│       ├── App.tsx       # Main React component
│       ├── frontend.tsx  # Entry point
│       └── index.html    # HTML template
├── AGENTS.md             # Agent guidelines
├── app.ts                # Application entry point
├── tsconfig.json         # TypeScript configuration
├── package.json          # Dependencies and scripts
└── README.md             # Project documentation

Available Commands

After creating your project, you can run:

Development

bun dev

Starts the development server at http://localhost:3500

Build

bun build

Compiles your application into the .agentuity/ directory

Type Check

bun typecheck

Runs TypeScript type checking

Deploy to Agentuity

bun run deploy

Deploys your application to the Agentuity cloud

Next Steps

After creating your project:

1. Customize the example agent - Edit src/agent/hello/agent.ts
2. Add new agents - Create new folders in src/agent/
3. Add new APIs - Create new folders in src/api/
4. Add Web files - Create new routes in src/web/
5. Customize the UI - Edit src/web/app.tsx
6. Configure your app - Modify app.ts to add middleware, configure services, etc.

Creating Custom Agents

Create a new agent by adding a folder in src/agent/:

// src/agent/my-agent/agent.ts
import { createAgent } from '@agentuity/runtime';
import { s } from '@agentuity/schema';

const agent = createAgent({
	description: 'My amazing agent',
	schema: {
		input: s.object({
			name: s.string(),
		}),
		output: s.string(),
	},
	handler: async (_ctx, { name }) => {
		return `Hello, ${name}! This is my custom agent.`;
	},
});

export default agent;

Adding API Routes

Create custom routes in src/api/:

// src/api/my-agent/route.ts
import { createRouter } from '@agentuity/runtime';
import myAgent from './agent';

const router = createRouter();

router.get('/', async (c) => {
	const result = await myAgent.run({ message: 'Hello!' });
	return c.json(result);
});

router.post('/', myAgent.validator(), async (c) => {
	const data = c.req.valid('json');
	const result = await myAgent.run(data);
	return c.json(result);
});

export default router;

Learn More

• Agentuity Documentation
• Bun Documentation
• Hono Documentation
• Zod Documentation

Requirements

• Bun v1.0 or higher
• TypeScript 5+