Introduction

Scaffold new Astreus AI agent projects with best practices and sensible defaults. Interactively configure your agent with the features you need.

Why Create Astreus Agent?#

Starting a new AI agent project from scratch can be tedious. create-astreus-agent handles the boilerplate so you can focus on building:

  • Interactive Setup - Answer a few questions, get a fully configured project
  • Feature Selection - Only include what you need (memory, RAG, graphs, etc.)
  • Multi-Provider Ready - Pre-configured for any LLM provider
  • TypeScript Support - Full type safety out of the box
  • Best Practices - Project structure that scales

Quick Start#

bash
npx create-astreus-agent my-agent
cd my-agent
npm install
npm run dev

That's it! You have a working AI agent.

What You Get#

text
my-agent/
├── src/
│   └── index.ts      # Main entry point with agent setup
├── package.json      # Dependencies and scripts
├── tsconfig.json     # TypeScript configuration
├── .env.example      # Environment variables template
├── .gitignore        # Git ignore rules
└── README.md         # Project documentation

Interactive Setup#

The CLI guides you through configuration:

text
? What is your project name? my-agent
? Which features do you want to include?
  ◉ Memory - Persistent agent memory
  ◉ Knowledge (RAG) - Document retrieval
  ◯ Graph Workflows - Task orchestration
  ◯ Sub-Agents - Multi-agent coordination
? Which LLM provider? OpenAI
? Use TypeScript? Yes

Next Steps#