Ship to HACS with confidence

HACS Integration Preflight is a VS Code extension that validates your Home Assistant custom integrations before submission. Catch errors early, autofix common issues, and pass HACS review the first time.

Install from Marketplace
VS Code
Autofix Support
Free & Open Source
HACS Preflight
Integration Preflight
Preflight Check Results
Repository
manifest.json
CI/Workflows - Click to fix
Validation

Comprehensive preflight checks

Every check HACS reviewers look for, automated in your editor.

Repository Structure

Validates git setup, GitHub remote, and custom_components/<domain>/ directory structure.

manifest.json

Checks required keys, domain matching, codeowners format, and key ordering with one-click autofix.

hacs.json

Validates repository name, country codes (ISO 3166-1), Home Assistant version format, and zip settings.

GitHub Metadata

Verifies repo visibility, description, issues enabled, topics, and release availability.

CI/Workflows

Checks for hacs/action workflow with correct category. Add or repair with one click.

Branding

Verifies icon and logo assets exist on brands.home-assistant.io for your domain.

Commands

Available commands

Access from the Command Palette (Cmd/Ctrl+Shift+P) or the activity bar.

HACS: Run Integration Preflight Check

Run all validation checks and display results in the sidebar panel.

HACS: Autofix manifest.json ordering

Reorder manifest keys to HACS standard (domain, name, then alphabetical).

HACS: Add/Repair CI Workflows

Preview and apply the official hacs/action workflow file.

HACS: Check Home Assistant Brands status

Verify your integration's branding assets are submitted.

Get Started

  1. Install the extension: Search for "HACS Integration Preflight" in VS Code or install from the Marketplace.

  2. Open your integration: Open the folder containing your custom_components/<domain>/ directory in VS Code.

  3. Run preflight: Click the HACS icon in the activity bar or run HACS: Run Integration Preflight Check from the Command Palette.

  4. Fix issues: Click on any issue to autofix or navigate to the problem. Re-run to verify fixes.

  5. Submit to HACS: Once all checks pass, submit your integration to HACS with confidence!

Tip: Set hacsPreflight.githubToken in VS Code settings for enhanced GitHub metadata and release checks.

Configuration

  1. hacsPreflight.githubToken — GitHub Personal Access Token for repository metadata and release checks (optional).

  2. hacsPreflight.brandsCheck — Enable remote check against brands.home-assistant.io (default: true).