Templates

Information about project templates and common configurations.

Default Project#

When you run create-astreus-agent, you get an interactive setup that generates a project based on your selections.

bash

npx create-astreus-agent my-agent

The generated project includes everything you need to get started.

Generated Project Structure#

text

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

Package.json Scripts#

json

{
  "scripts": {
    "dev": "tsx src/index.ts",
    "build": "tsc",
    "start": "node dist/index.js"
  }
}

Common Configurations#

Basic Chat Agent#

Select only Memory feature for a simple conversational agent:

text

? Which features do you want to include?
  ◉ Memory - Persistent agent memory with vector search
  ◯ Knowledge (RAG)
  ◯ Graph Workflows
  ◯ Sub-Agents
  ◯ Custom Plugins
  ◯ MCP Integration

RAG-Enabled Agent#

Select Memory and Knowledge for document-aware responses:

text

? Which features do you want to include?
  ◉ Memory - Persistent agent memory with vector search
  ◉ Knowledge (RAG) - Document ingestion and retrieval
  ◯ Graph Workflows
  ◯ Sub-Agents
  ◯ Custom Plugins
  ◯ MCP Integration

Full-Featured Agent#

Select all features for maximum capabilities:

text

? Which features do you want to include?
  ◉ Memory - Persistent agent memory with vector search
  ◉ Knowledge (RAG) - Document ingestion and retrieval
  ◉ Graph Workflows - DAG-based task orchestration
  ◉ Sub-Agents - Multi-agent coordination
  ◉ Custom Plugins - Extensible tool system
  ◉ MCP Integration - Model Context Protocol support

Provider-Specific Setup#

OpenAI#

Default model: gpt-4o

Generated .env.example:

text

OPENAI_API_KEY=your-api-key-here

Anthropic (Claude)#

Default model: claude-sonnet-4-20250514

Generated .env.example:

text

ANTHROPIC_API_KEY=your-api-key-here

Google (Gemini)#

Default model: gemini-2.0-flash

Generated .env.example:

text

GEMINI_API_KEY=your-api-key-here

Ollama (Local)#

Default model: llama3

Generated .env.example:

text

# Ollama runs locally, no API key needed
OLLAMA_HOST=http://localhost:11434

Multiple Providers#

Generated .env.example:

text

# Add API keys for providers you want to use
OPENAI_API_KEY=your-openai-key
ANTHROPIC_API_KEY=your-anthropic-key
GEMINI_API_KEY=your-gemini-key

Feature Comparison#

Feature	Use Case
Memory	Remembering user preferences, conversation history
Knowledge	Documentation Q&A, research assistants
Graph	Multi-step workflows, pipelines
Sub-Agents	Specialized tasks, parallel processing
Plugins	Custom tools, API integrations
MCP	Standardized tool ecosystem

Next Steps#

After creating your project:

bash

cd my-agent
npm install
cp .env.example .env
# Edit .env with your API keys
npm run dev

See Configuration for detailed environment setup.