umbraco-health

Run Umbraco health checks against selected groups via management API.

4|Updated Mar 6, 2026
One-click install
npx skills add https://github.com/albanistrefi/umbraco_CLI --skill umbraco-health
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: umbraco-health
Source: https://github.com/albanistrefi/umbraco_CLI/tree/main/skills/cli/umbraco-health
Command: npx skills add https://github.com/albanistrefi/umbraco_CLI --skill umbraco-health

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Umbraco admins and operators need a reliable way to verify that the Umbraco instance (and its components) is functioning correctly before users are impacted.

Core Features & Use Cases

  • Health group inspection: Retrieve details for a specific health group to understand what will be checked and why it matters.
  • Group discovery: List all available health check groups to plan diagnostics across the instance.
  • Health check execution: Run health checks for a chosen group and (optionally) execute specific health actions when deeper validation is required.

Quick Start

Ask the assistant to run the command "umbraco health groups" to list available health groups, then run "umbraco health run <group-name> --dry-run" to validate the checks before executing them.

Frequently Asked Questions about umbraco-health

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I run Umbraco health checks from the command line?

You can run Umbraco health checks by listing available groups with "umbraco health groups", then executing "umbraco health run <group-name>". Add the --dry-run flag to validate operations safely without applying mutations, or use --json for targeted health action payloads.

What are Umbraco health check groups and when do I need them?

Umbraco health check groups are categorized diagnostic tests for your deployment. You need them during incident response, pre-release validation, or ongoing operational monitoring to verify that Umbraco components are functioning correctly before users are impacted.

Do I need authentication configured to use Umbraco management API health diagnostics?

Yes, executing Umbraco health diagnostics requires mandatory prerequisite authentication rules from umbraco-shared. Without this authentication configured, the CLI cannot access the management API to retrieve health group details or run checks against the deployment.

Can I validate Umbraco health actions without making changes to the instance?

Yes, you can validate Umbraco health actions without applying changes by appending the --dry-run flag to your command. This performs safe mutation validation, allowing you to preview checks before executing live health action payloads against the Umbraco management API.

What's the best way to monitor Umbraco deployment health continuously?

The best way to monitor Umbraco deployment health continuously is to execute health checks across available groups via the management API. Retrieve group details and run targeted checks with --json output, integrating the results into your ongoing operational monitoring systems.