Blueprint Studio - A Modern File Editor for Home Assistant

Blueprint Studio - A Modern File Editor for Home Assistant :rocket:

Category: Integrations

Tags: integration #editor yaml #custom-component hacs


Hey everyone! :waving_hand:

I’m excited to share Blueprint Studio, a new custom integration I’ve been working on that brings a professional, VS Code-like file editing experience directly into your Home Assistant dashboard.


:thinking: The Problem

We’ve all been there - you need to quickly edit a YAML file, tweak an automation, or fix a configuration error. Your options are usually:

  • SSH into your system

  • Use an external SFTP client

  • Install a heavy add-on like VS Code Server

  • Use the basic File Editor add-on

What if you could just… edit files directly in Home Assistant with a modern, powerful editor? That’s why I built Blueprint Studio.


:sparkles: What is Blueprint Studio?

Blueprint Studio is a custom integration that adds a full-featured code editor to your Home Assistant sidebar. Think VS Code, but built right into your HA interface.

Blueprint Studio HACS HA


:bullseye: Key Features

Professional Editor

  • :white_check_mark: Syntax highlighting for YAML, JSON, Python, JavaScript, HTML, CSS, Markdown, Shell

  • :white_check_mark: Real-time YAML validation - Catch errors before you save!

  • :white_check_mark: Multi-tab interface - Edit multiple files at once

  • :white_check_mark: Code folding, bracket matching, line numbers

  • :white_check_mark: Search and replace functionality

  • :white_check_mark: Keyboard shortcuts (Ctrl+S to save, Ctrl+F to search, etc.)

File Management

  • :white_check_mark: File tree explorer with expandable folders

  • :white_check_mark: Create, delete, rename, copy, move files and folders

  • :white_check_mark: Upload files or entire folders (ZIP support)

  • :white_check_mark: Download files or folders as ZIP archives

  • :white_check_mark: File search to quickly find what you need

Security & Safety

  • :locked: Admin-only access - Only administrators can use it

  • :shield: Path protection - Can’t access files outside config directory

  • :page_facing_up: File type restrictions - Only edit safe text files

  • :locked_with_key: Critical file protection - Can’t delete configuration.yaml or secrets.yaml

  • :sunglasses: Hidden sensitive folders - .storage and other critical directories are hidden

Dark Theme

  • :crescent_moon: Clean, VS Code-inspired dark interface

  • :eye: Easy on the eyes for late-night config editing

  • :artist_palette: Syntax highlighting optimized for dark backgrounds


:wrench: Installation

Via HACS (Recommended)

  1. Add Custom Repository:
  • Open HACS

  • Go to Integrations

  • Click the three dots (⋮) → Custom repositories

  • Add: https://github.com/soulripper13/blueprint-studio

  • Category: Integration

  1. Install:
  • Search for “Blueprint Studio” in HACS

  • Click Download

  • Restart Home Assistant

  1. Configure:
  • Go to Settings → Devices & Services → Add Integration

  • Search for “Blueprint Studio”

  • Click to add

  1. Access:
  • Look for “Blueprint Studio” in your sidebar

  • Start editing!

Manual Installation

Download from GitHub Releases, extract to custom_components/blueprint_studio, restart, and add via integrations.


:graduation_cap: Use Cases

Here’s what I’ve been using it for:

  • :pencil: Quick edits to automations.yaml without restarting SSH

  • :magnifying_glass_tilted_left: Debugging integration configurations with syntax highlighting

  • :memo: Creating and editing Lovelace dashboard YAML

  • :bug: Fixing YAML syntax errors with real-time validation

  • :package: Backing up configs by downloading folders as ZIP

  • :rocket: Testing new automations in a separate file before merging

What would you use it for?


:vs_button: How Does It Compare?

| Feature | Blueprint Studio | File Editor (Add-on) | VS Code Server | SSH/SFTP |

|---------|------------------|---------------------|----------------|----------|

| Installation | Custom Component | Add-on | Add-on | External |

| Resource Usage | Lightweight | Low | High | Minimal |

| Interface | VS Code-like, Multi-tab | Simple, Single file | Full VS Code | Terminal |

| YAML Validation | :white_check_mark: Built-in | :cross_mark: | :white_check_mark: Extensions | :cross_mark: |

| File Management | :white_check_mark: Full | :warning: Basic | :white_check_mark: Full | :white_check_mark: Full |

| Learning Curve | Low | Very Low | Medium | High |


:keyboard: Keyboard Shortcuts

One of my favorite features - familiar shortcuts that just work:

  • Ctrl+S / Cmd+S - Save file

  • Ctrl+Shift+S - Save all open files

  • Ctrl+F - Search in file

  • Ctrl+H - Search and replace

  • Ctrl+G - Go to line

  • Ctrl+/ - Toggle comment

  • Ctrl+W - Close tab

  • Ctrl+Z - Undo

  • Ctrl+Y - Redo


:bug: Known Issues & Limitations

Being transparent about current limitations:

  • No light theme yet - Dark theme only (planned for v1.1)

  • No git integration - Can’t commit changes directly (planned for future)

  • Admin only - By design for security, but means non-admin users can’t use it

  • Config directory only - Can’t edit files outside HA config (security feature)


:world_map: Roadmap

I’m actively developing and have plans for:

  • :sun_with_face: Light theme option

  • :gear: Configurable editor settings (font size, tab size, etc.)

  • :counterclockwise_arrows_button: File diff viewer

  • :bar_chart: Git integration for version control

  • :magnifying_glass_tilted_left: Search across all files

  • :floppy_disk: Built-in backup/restore

  • :scroll: File history/versioning

What features would YOU like to see? Drop your ideas in the comments!


:handshake: Looking for Feedback!

This is v1.0.0 - the first stable release. I’ve tested it extensively on my own system, but I’d love to hear from the community:

  • :bug: Bug reports - If something breaks, please let me know!

  • :light_bulb: Feature suggestions - What’s missing? What would make it better?

  • :camera_with_flash: Screenshots - If you install it, share screenshots!

  • :star: General feedback - Too simple? Too complex? Just right?

I’m very open to contributions and suggestions. This is for the community, so your input matters!


5 Likes

nice… but needs the next and previous button on search results… its kinda required for any code editor instead of just highlighting the results and you have to manually scroll and search for each search result hit…

Yea I know working on improvements and suggestions. I’m only one guy doing this in my spare time. so please bear with me.

I’m currently working on some improvements and features. Should be available soon in a day or two.

I’ve released a new minor update v1.3.1. There will a new one v1.3.2 also soon with new features that i’m curently testing and debugging.

# Blueprint Studio v1.3.2 Release Notes

This release introduces powerful visual tools for reviewing code changes, bulk file management, and a significantly upgraded search experience.

## ✨ New Features

### 📦 Bulk Download
*   **Select Multiple**: Enter selection mode via the new checklist icon to pick multiple files and folders.
*   **Auto-Zipping**: Click download to receive a single `.zip` file containing all your selected items, keeping directory structures intact.

### 🔍 Visual Diff Viewer (Integrated)
*   **Compare Changes Anywhere**: See exactly what you changed directly from the file explorer.
*   **Side-by-Side View**: Modified files now show a "Difference" icon in the tree; click it to see your current work vs the last commit.
*   **Color Coded**: Deletions are highlighted in red, additions in green, optimized for high readability in both Dark and Light themes.

### 🔎 Professional Search & Replace
We've significantly upgraded the search functionality to make finding and navigating code even easier!
*   **Enhanced Widget**: A new floating search tool with dedicated buttons for Next, Previous, Replace, and Replace All.
*   **Live Match Counting**: Instantly see "X of Y" matches (e.g., "1 of 10") in the search toolbar as you navigate.
*   **Distinct Active Highlight**: The currently selected match is now highlighted in vivid orange with black text.
*   **Smart Wrapping**: Search now automatically wraps around to the beginning (or end) of the file.
*   **Keyboard Shortcuts**: `Ctrl+F` to Find, `Ctrl+H` to Replace. Use `Enter` for next, `Shift+Enter` for previous.

### 🛡️ Optimized .gitignore Editor
*   **Clean & Efficient**: The exclusions manager now automatically detects redundant rules. If you ignore a folder, it won't clutter your `.gitignore` file with every single file inside it.
*   **Intelligent Toggle**: Background Git tasks and UI notifications now fully respect your Git Integration settings.

## 🚀 Improvements & Polish
*   **Enhanced Scrolling**: Improved the diff viewer behavior on smaller screens and mobile devices.
*   **Smart Selection**: Improved cascading checkbox logic for complex folder structures.
*   **Theme Optimization**: Fine-tuned colors for syntax highlighting and UI elements to ensure maximum readability.

1 Like

Thank you. Something is not straight though as I can see the update (after active searching), but it has the same version number 1.3.0 from HA’s view and can’t be installed.

Hmm that’s weird. let me check


Looks like a cache problem with your browser

Probably a sync issue on the internet servers. It is showing now.

Small issue: at every start of the addon I am being greeted again by the same GIT integration initialization screen. I don’t need/want GIT, but I can’t find a way to permanently deactivate the option.

Ahh got you !!! I’m currently debugging that in the version 1.3.2. Just go throught it once then close it

If you close it and turn off the github integration in settings does it still happen?

No, once through the init process the settings are kept.

Ah no, now I am getting a 401 error:

A login error is thrown. Refreshing the browser window helps, but that doesn’t appear normal to me :innocent:

Logger: homeassistant.components.http.ban
Quelle: components/http/ban.py:136
Integration: HTTP (Dokumentation, Probleme)
Erstmals aufgetreten: 11:34:07 (2 Vorkommnisse)
Zuletzt protokolliert: 11:34:07

Login attempt or request with invalid authentication from 2a00:6020:ad2d:4b00:e188:4e01:7469:ef4d (2a00:6020:ad2d:4b00:e188:4e01:7469:ef4d). Requested URL: ‘/api/blueprint_studio?action=list_all&show_hidden=false’. (Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/144.0.0.0 Safari/537.36 Edg/144.0.0.0)

The login error reappeared. There is no debug log, or is there?

One more small thing: the Recent File list is continuously growing and uses the bigger part of the screen.

Currently it is not possible to limit the size of the Recent File part. Ideally Recent Files would be displayed in a separate virtual screen with its own slider.

No there is no debug log. It’s a problem from being inactive. Should remedy it in the next iteration. I’ll add scroll also to the recent files. I don’t use it that why i didn’t notice. I’ll limit it to 3 files and add scroll

1 Like

One more thing in 1.3.1: I can no longer unhide files. This throws a 401 error.

After you refresh does it work then?

Are you working remotely with the integration by any chance?

No, I am at home and the access is local.

I reset the whole thing and set it up again. It is working for the moment. How long does it need to be idle to trigger a possible connection issue? I will check it again later.

In the same hidden file context: can I access HA’s \config directory?

By default in the file explorer you’re in config directory