conf-edit-ha

KO | EN

gitlite — search

#javascript #hacktoberfest #react #typescript #go #machine-learning #rust #deep-learning #linux #docker #awesome #kubernetes #awesome-list #mcp

(★ 31)

Lightweight YAML configuration editor for Home Assistant

conf-edit-ha 최신버젼 다운로드

최종 버전 다운로드 (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# <img src="icon.png" width="32" height="32" style="vertical-align: middle;"> Home Assistant Configuration Editor

[![GitHub Release](https://img.shields.io/github/v/release/roman-pinchuk/conf-edit-ha?style=flat-square)](https://github.com/roman-pinchuk/conf-edit-ha/releases)
[![Builder](https://github.com/roman-pinchuk/conf-edit-ha/actions/workflows/builder.yaml/badge.svg)](https://github.com/roman-pinchuk/conf-edit-ha/actions/workflows/builder.yaml)
[![CodeQL](https://github.com/roman-pinchuk/conf-edit-ha/actions/workflows/github-code-scanning/codeql/badge.svg)](https://github.com/roman-pinchuk/conf-edit-ha/security/code-scanning)
[![Dependabot](https://img.shields.io/badge/dependabot-enabled-025E8C?logo=Dependabot&style=flat-square)](https://github.com/roman-pinchuk/conf-edit-ha/security/dependabot)
[![Last commit](https://img.shields.io/github/last-commit/roman-pinchuk/conf-edit-ha?style=flat-square)](https://github.com/roman-pinchuk/conf-edit-ha/commits/main)
[![License](https://img.shields.io/github/license/roman-pinchuk/conf-edit-ha?style=flat-square)](https://raw.githubusercontent.com/roman-pinchuk/conf-edit-ha/main/LICENSE.md)
[![Python](https://img.shields.io/badge/python-3.11-blue?style=flat-square&logo=python&logoColor=white)](https://www.python.org/)
[![Home Assistant Ingress](https://img.shields.io/badge/Home%20Assistant-Ingress-blue?style=flat-square)](https://developers.home-assistant.io/docs/apps/presentation/#ingress)
![Supports amd64](https://img.shields.io/badge/amd64-yes-green?style=flat-square)
![Supports aarch64](https://img.shields.io/badge/aarch64-yes-green?style=flat-square)

A lightweight Home Assistant add-on that provides a simple text editor for configuration files with YAML and JSON syntax highlighting, entity autocomplete, and Home Assistant config validation after saving.

## Features

- **Lightweight CodeMirror 6 editor** (~1MB, 10x smaller than Monaco)
- **Real-time client validation**: Blocks saving if there are YAML or JSON syntax errors
- **One-click "Restore Valid State"** to quickly undo broken configuration edits
- **Home Assistant config validation** after save using the same config check API as Developer Tools
- **Entity autocomplete** (substring matching from live HA API)
- **VS Code-style file tree** with expand/collapse and indentation guides
- **Rainbow indentation** for YAML structure visualization
- **Configurable indentation guides** with colored spaces or vertical lines and adjustable opacity
- **Dark/light theme** with automatic system preference detection
- **Optional Prettier formatting** for YAML and JSON when saving
- **State persistence** - remembers last opened file
- **Tree browser** with folder navigation
- **Auto-backup** on every save (creates `.backup` files)
- **Multi-architecture support** (amd64, aarch64, armv7, armhf, i386)
- **Ingress support** - runs securely within Home Assistant

## Installation

### Quick Install

Click the button below to add this repository to your Home Assistant:

[![Open your Home Assistant instance and show the add add-on repository dialog with a specific repository URL pre-filled.](https://my.home-assistant.io/badges/supervisor_add_addon_repository.svg)](https://my.home-assistant.io/redirect/supervisor_add_addon_repository/?repository_url=https%3A%2F%2Fgithub.com%2Froman-pinchuk%2Fconf-edit-ha)

### Manual Installation

1. In Home Assistant, go to **Settings → Add-ons → Add-on Store**
2. Click the **three dots menu** (top right) → **Repositories**
3. Add this repository URL: `https://github.com/roman-pinchuk/conf-edit-ha`
4. Find "Configuration Editor" in the add-on store and click **Install**
5. Start the add-on
6. Access via the sidebar panel "Config Editor"

## Configuration

Visual settings are available immediately from the gear button in the editor. Use it to change the theme, indentation guides, guide opacity, font size, line wrapping, and rainbow brackets.

Enable **Format YAML and JSON on save** in the appearance settings to apply Prettier formatting before saving. It is disabled by default.

## Usage

1. Open the add-on from the Home Assistant sidebar
2. Select a YAML, JSON, Python, or shell file from the file browser
3. Edit the file with syntax highlighting
4. Type to get entity autocomplete suggestions
5. Real-time validation will instantly detect YAML or JSON syntax errors and block saving. YAML files also provide entity suggestions. You can click **Restore Valid State** to easily undo invalid edits.
6. Click "Save" to save changes (creates automatic backup)
7. Review the Home Assistant validation result in the status bar
8. If backend validation fails, click or tap the status bar to expand the full error details

## Tech Stack

- Backend: Python + Flask
- Frontend: TypeScript + CodeMirror 6 + Vite
- Container: ~50MB total size
  <img width="1300" height="75" alt="image" src="https://github.com/user-attachments/assets/93946715-9f8c-4892-9556-d94dfc11e9e0" />

## Security

- All file operations are restricted to `/config` directory
- Automatic backups created before each save
- No external dependencies or internet access required

## Development

### Quick Start

```bash
# Build everything and run
make build run

# Or step by step:
make build-frontend  # Build frontend
make build-docker    # Build Docker image
make run            # Start container

# View logs
make logs

# Restart after changes
make restart
```

### Building for Multiple Architectures

The add-on automatically builds for all supported architectures when published to Home Assistant. For local multi-arch testing:

```bash
make build-multiarch
```

See [BUILD.md](BUILD.md) for detailed build instructions.

### Project Structure

```
conf-edit-ha/
├── app.py              # Flask backend
├── frontend/           # TypeScript + Vite frontend
│   ├── src/
│   │   ├── main.ts     # App entry point
│   │   ├── editor.ts   # CodeMirror setup
│   │   ├── api.ts      # API client
│   │   └── theme.ts    # Theme management
│   └── styles.css      # VS Code-style CSS
├── static/             # Built frontend (generated)
├── config.yaml         # Add-on configuration
├── build.yaml          # Multi-arch build config
└── Dockerfile          # Container definition
```

## Support

For issues and feature requests, visit: [GitHub Issues](https://github.com/roman-pinchuk/conf-edit-ha/issues)

## License

This project is licensed under the [MIT License](LICENSE.md).

conf-edit-ha

conf-edit-ha 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

conf-edit-ha

conf-edit-ha 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README