home-assistant.io/source/_docs/tools/check_config.markdown
c0ffeeca7 8d98500d0e
Docs c z apply sentence style caps add term refs (#29892)
* Docs a-b: apply sentence-style-caps, add term refs

* Docs: apply sentence-style-caps, add term refs

* Apply suggestions from code review

* Glossary: add alias for plural

* Apply suggestions from code review

Co-authored-by: Joakim Sørensen <joasoe@gmail.com>

---------

Co-authored-by: Joakim Sørensen <joasoe@gmail.com>
2023-11-18 14:36:08 +01:00

31 lines
1.0 KiB
Markdown

---
title: "check_config"
description: "Script to perform a check of the current configuration"
---
Test any changes to your `configuration.yaml` file before launching Home Assistant. This {% term script %} allows you to test changes without the need to restart Home Assistant.
```bash
hass --script check_config
```
The script has further options like checking configuration files which are not located in the default directory or showing your secrets for debugging.
```bash
$ hass --script check_config -h
usage: hass [-h] [--script {check_config}] [-c CONFIG] [-i [INFO]] [-f] [-s]
Check Home Assistant configuration.
optional arguments:
-h, --help show this help message and exit
--script {check_config}
-c CONFIG, --config CONFIG
Directory that contains the Home Assistant
configuration
-i [INFO], --info [INFO]
Show a portion of the config
-f, --files Show used configuration files
-s, --secrets Show secret information
```