---
title: "File"
description: "File is a built-in integration for Home Assistant. It has 6.6k installs sharing analytics and works locally."
canonical: "https://vulpo.app/integrations/core/file"
url: "https://vulpo.app/integrations/core/file.md"
last-updated: "2026-10-22"
version: "1.4"
---

# File

> File is a built-in integration for Home Assistant. It has 6.6k installs sharing analytics and works locally.

File is a built-in Home Assistant integration that writes notifications to a local file and reads values from files into sensors. It adds a notifier that appends messages to a chosen file path, with an option to add a timestamp to each notification. It also adds a sensor that takes its value from a local file, with a unit of measurement and a value template that renders the state from the file content. A read file action returns the contents of a file, which is useful in automations and scripts. Everything runs locally, and setup and later changes to options happen in the UI.

Automatic summary of Home Assistant's source code. Something wrong? [Get in touch](https://vulpo.app/contact)

[Open in My Home Assistant](https://my.home-assistant.io/redirect/config_flow_start/?domain=file)

## Supports

- **Works locally**: Talks to your devices on your own network. No vendor cloud in between.
- **Set up in the UI**: Add it in Settings, Devices and services. Nothing to download.
- **Updated with Home Assistant**: Ships and updates with every Home Assistant release.

## Setting it up

It is added under Settings, Devices and services, with Add integration.

### Notification to file service

- **File path**: A local file path to write the notification to
- **Timestamp**: Add a timestamp to the notification

### File sensor

- **File path**: The local file path to retrieve the sensor value from
- **Unit of measurement**: Unit of measurement for the sensor
- **Value template**: A template to render the sensor's value based on the file content

### After setup

- **Timestamp**: Add a timestamp to the notification
- **Unit of measurement**: Unit of measurement for the sensor
- **Value template**: A template to render the sensor's value based on the file content

Texts from Home Assistant's source code, [Apache License 2.0](https://www.apache.org/licenses/LICENSE-2.0).

## Actions

- **Read file**: Reads a file and returns the contents.
  Fields: File encoding, File name

## At a glance

- Kind: Built-in integration
- Category: [DIY and makers](https://vulpo.app/integrations/category/diy-and-makers.md), Web and data connectors
- Number: 6.6k installs sharing analytics
- Connection: Works locally
- Upkeep: Part of Home Assistant
- Needs: Built into Home Assistant
- Domain: `file`
- Source: <https://www.home-assistant.io/integrations/file/>

In Vulpo: Chart card, Apple Watch

Independent directory, made by the developer of Vulpo. Not affiliated with Home Assistant or the Open Home Foundation. [About these numbers](https://vulpo.app/integrations/about)

Last updated 2026-10-22. Source: https://vulpo.app/integrations/core/file

---

- HTML version of this page: https://vulpo.app/integrations/core/file
- Site index for agents: https://vulpo.app/llms.txt
- Everything in one document: https://vulpo.app/llms-full.txt
- All pages: https://vulpo.app/sitemap.xml