The Umbraco Compose example project is a C# client library and CLI that demonstrates cross-collection content composition with automatic reference expansion. Perfect for developers who want to experiment with Umbraco Compose, this project provides ready-made examples and schemas to get you started quickly. Clone the repository, configure your Compose credentials, and start exploring the platform's capabilities.
Download
You can download the Umbraco Compose example project here: https://github.com/jbreuer/Umbraco-Compose-example-project
Getting started
I've also made a getting started video that walks through the complete setup: https://youtu.be/tXdbHn14Gn8
Run commands
After cloning and configuring your credentials, navigate to the CLI folder and run these commands to see the full workflow:
# Test authentication
dotnet run -- auth:test
# Create environment and collections
dotnet run -- setup:dev
dotnet run -- collections:create dev articles "Articles Collection"
dotnet run -- collections:create dev products "Products Collection"
# Create schemas
dotnet run -- schemas:create dev article
dotnet run -- schemas:create dev product
# Ingest content (products first, then articles)
dotnet run -- ingest:products-bulk dev
dotnet run -- ingest:articles-bulk dev
# Query content
dotnet run -- query:articles dev
dotnet run -- query:products dev
# 🎯 Query with automatic product nesting (demonstrates Compose's core value!)
dotnet run -- query:composed dev
dotnet run -- query:typed dev
Key features
The main feature demonstrated is cross-collection composition with automatic reference expansion. When you query articles, the referenced products are automatically expanded and nested inside the article results, eliminating the need for client-side data matching.
The project showcases:
- Comprehensive CLI for setup, ingestion, and queries
- Both JSON output (query:composed) and strongly-typed models (query:typed)
- Complete CRUD operations across environments, collections, and schemas
- Schema definitions with $ref and $delivery.refCollection for cross-collection references