AI integration layer for Umbraco CMS, built on Microsoft.Extensions.AI.

---

Products

This is a monorepo containing multiple Umbraco.AI packages:

Core

Addons

Deploy

Providers

Quick Start

The fastest way to get started is using the install-demo script, which creates a unified development environment with all packages and a demo Umbraco site:

# Windows
.\scripts\install-demo-site.ps1

# Linux/Mac
./scripts/install-demo-site.sh

This creates:

• Umbraco.AI.local.slnx - Unified solution with all products
• demos/v18/Umbraco.AI.DemoSite/ - Umbraco instance with all packages referenced

After running the script, build the frontend and backend:

# Install frontend dependencies
npm install

# Build all frontend packages
npm run build

# Build the unified solution
dotnet build Umbraco.AI.local.slnx

# Run the demo site (from demos/v18/Umbraco.AI.DemoSite/)
cd demos/v18/Umbraco.AI.DemoSite
dotnet run

Demo site credentials: admin@example.com / password1234

Local Development

Building Individual Products

Each product has its own solution file and can be built independently:

# Build individual products (same pattern for every product)
dotnet build Umbraco.AI/Umbraco.AI.slnx
dotnet build Umbraco.AI.Agent/Umbraco.AI.Agent.slnx
dotnet build Umbraco.AI.Agent.UI/Umbraco.AI.Agent.UI.slnx
dotnet build Umbraco.AI.Agent.Copilot/Umbraco.AI.Agent.Copilot.slnx
dotnet build Umbraco.AI.Agent.Copilot.Workspace/Umbraco.AI.Agent.Copilot.Workspace.slnx
dotnet build Umbraco.AI.Prompt/Umbraco.AI.Prompt.slnx
dotnet build Umbraco.AI.Search/Umbraco.AI.Search.slnx
dotnet build Umbraco.AI.Automate/Umbraco.AI.Automate.slnx
dotnet build Umbraco.AI.Deploy/Umbraco.AI.Deploy.slnx
dotnet build Umbraco.AI.Prompt.Deploy/Umbraco.AI.Prompt.Deploy.slnx
dotnet build Umbraco.AI.Agent.Deploy/Umbraco.AI.Agent.Deploy.slnx
dotnet build Umbraco.AI.OpenAI/Umbraco.AI.OpenAI.slnx
dotnet build Umbraco.AI.Anthropic/Umbraco.AI.Anthropic.slnx
dotnet build Umbraco.AI.Amazon/Umbraco.AI.Amazon.slnx
dotnet build Umbraco.AI.Google/Umbraco.AI.Google.slnx
dotnet build Umbraco.AI.MicrosoftFoundry/Umbraco.AI.MicrosoftFoundry.slnx
dotnet build Umbraco.AI.Mistral/Umbraco.AI.Mistral.slnx
dotnet build Umbraco.AI.DeepSeek/Umbraco.AI.DeepSeek.slnx
dotnet build Umbraco.AI.HuggingFace/Umbraco.AI.HuggingFace.slnx
dotnet build Umbraco.AI.FireworksAI/Umbraco.AI.FireworksAI.slnx
dotnet build Umbraco.AI.TogetherAI/Umbraco.AI.TogetherAI.slnx
dotnet build Umbraco.AI.Alibaba/Umbraco.AI.Alibaba.slnx
dotnet build Umbraco.AI.Moonshot/Umbraco.AI.Moonshot.slnx
dotnet build Umbraco.AI.OpenRouter/Umbraco.AI.OpenRouter.slnx
dotnet build Umbraco.AI.ZAI/Umbraco.AI.ZAI.slnx

Frontend Development (npm Workspaces)

This monorepo uses npm workspaces for frontend dependency management. Add-on packages (@umbraco-ai/prompt, @umbraco-ai/agent) automatically reference the local @umbraco-ai/core during development using the workspace:* protocol.

# Install all workspace dependencies (run from monorepo root)
npm install

# Build all frontends (sequential: core -> prompt -> agent)
npm run build

# Watch all frontends in parallel
npm run watch

# Build/watch specific packages
npm run build:core
npm run build:prompt
npm run watch:agent

Workspace Benefits:

• Single npm install installs all dependencies across all packages
• Automatic local package linking (no manual npm link required)
• Common dependencies are hoisted to the root node_modules
• workspace:* automatically replaced with published version during npm pack

Architecture

Umbraco.AI (Core)
    ├── Providers (depend on Core):
    │       OpenAI, Anthropic, Amazon, Google, MicrosoftFoundry,
    │       Mistral, DeepSeek, HuggingFace, FireworksAI, TogetherAI,
    │       Alibaba, Moonshot, OpenRouter, ZAI
    ├── Umbraco.AI.Prompt (Add-on - depends on Core)
    │   └── Umbraco.AI.Prompt.Deploy (Deploy - depends on Prompt + Deploy)
    ├── Umbraco.AI.Agent (Add-on - depends on Core)
    │   ├── Umbraco.AI.Agent.UI (Frontend library - depends on Agent)
    │   ├── Umbraco.AI.Agent.Copilot (Chat UI - depends on Agent + Agent.UI)
    │   ├── Umbraco.AI.Agent.Copilot.Workspace (Persisted chat + projects - depends on Agent + Core)
    │   ├── Umbraco.AI.Agent.Deploy (Deploy - depends on Agent + Deploy)
    │   └── Umbraco.AI.Automate (Umbraco Automate integration - depends on Agent)
    ├── Umbraco.AI.Search (Add-on - depends on Core)
    └── Umbraco.AI.Deploy (Deploy - depends on Core)

Documentation

• User Documentation - Getting started, concepts, API reference, and guides
• CLAUDE.md - Development guide, build commands, and coding standards
• Product-specific guides:
  • Umbraco.AI/CLAUDE.md - Core package
  • Umbraco.AI.Agent/CLAUDE.md - Agent add-on
  • Umbraco.AI.Agent.UI/CLAUDE.md - Agent UI library
  • Umbraco.AI.Agent.Copilot/CLAUDE.md - Agent Copilot add-on
  • Umbraco.AI.Agent.Copilot.Workspace/CLAUDE.md - Copilot Workspace add-on
  • Umbraco.AI.Prompt/CLAUDE.md - Prompt add-on
  • Umbraco.AI.Search/CLAUDE.md - Search add-on
  • Umbraco.AI.Automate/CLAUDE.md - Automate integration
  • Umbraco.AI.Deploy/CLAUDE.md - Deploy support
  • Umbraco.AI.Prompt.Deploy/CLAUDE.md - Deploy Prompt support
  • Umbraco.AI.Agent.Deploy/CLAUDE.md - Deploy Agent support

Target Framework

• .NET 10.0 (net10.0)
• Umbraco CMS 18.x
• Central Package Management via Directory.Packages.props

Contributing

Contributions are welcome! See CONTRIBUTING.md for guidelines on:

• Development workflow and branch naming conventions
• Commit message format (conventional commits)
• Changelog generation and maintenance
• Pull request process
• Release and deployment procedures
• Coding standards

For development setup and build commands, see CLAUDE.md.

License

This project is licensed under the MIT License. See LICENSE.md for details.