Skip to content

AGENTS.md

Latest commit

 

History

History
64 lines (44 loc) · 2.14 KB

AGENTS.md

File metadata and controls

64 lines (44 loc) · 2.14 KB

Agent Guidelines for default-template-example

Commands

  • Build: bun run build (compiles your application)
  • Dev: bun run dev (starts development server)
  • Typecheck: bun run typecheck (runs TypeScript type checking)
  • Deploy: bun run deploy (deploys your app to the Agentuity cloud)

Agent-Friendly CLI

The Agentuity CLI is designed to be agent-friendly with programmatic interfaces, structured output, and comprehensive introspection.

Read the AGENTS.md file in the Agentuity CLI for more information on how to work with this project.

Instructions

  • This project uses Bun instead of NodeJS and TypeScript for all source code
  • This is an Agentuity Agent project

Web Frontend (src/web/)

The src/web/ folder contains your React frontend, which is automatically bundled by the Agentuity build system.

File Structure:

  • index.html - Main HTML file with <script type="module" src="./frontend.tsx">
  • frontend.tsx - Entry point that renders the React app to #root
  • App.tsx - Your main React component
  • public/ - Static assets (optional)

How It Works:

  1. The build system automatically bundles frontend.tsx and all its imports (including App.tsx)
  2. The bundled JavaScript is placed in .agentuity/web/chunk/
  3. The HTML file is served at the root / route
  4. Script references like ./frontend.tsx are automatically resolved to the bundled chunks

Key Points:

  • Use proper TypeScript/TSX syntax - the bundler handles all compilation
  • No need for Babel or external bundlers
  • React is bundled into the output (no CDN needed)
  • Supports hot module reloading in dev mode with import.meta.hot
  • Components can use all modern React features and TypeScript

Example:

// src/web/App.tsx
import { useState } from 'react';

export function App() {
	const [count, setCount] = useState(0);
	return <button onClick={() => setCount((c) => c + 1)}>{count}</button>;
}

Learn More