home-assistant.io/source/_docs/tools/scripts.markdown
Ashton Campbell 9e6b9cb658 Fixed common spelling mistakes (#3544)
* fix spelling errors

* Update binary_sensor.xiaomi_aqara.markdown

Reverts to previous revision before spell check.

* Update tellstick.markdown

Reverts to previous revision before spell check.

* Update owntracks_two_mqtt_broker.markdown

Reverts to previous revision before spell check.

* Update cla_sign.html

Reverts to previous revision before spell check.

* Update credits.markdown

Reverts to previous revision before spell check.

* Update api.markdown

Fixed spell checker changing noone to no one.
2017-10-08 00:39:32 +02:00

1.6 KiB

layout, title, description, release_date, sidebar, comments, sharing, footer
layout title description release_date sidebar comments sharing footer
page Tools Description of tools which helps when using Home Assistant. 2017-02-23 11:00:00 true false true true

The command-line and the frontend which simplify common tasks, are helping with migrations, and ensure that Home Assistant runs properly. Please do not confuse those with Home Assistant's script feature.

{% linkable_title Configuration check %}

Test any changes to your configuration.yaml file before launching Home Assistant. This script allows you to test changes without the need to restart Home Assistant.

$ hass --script check_config

{% linkable_title Existence of configuration %}

This script checks if the configuration.yaml file exists. If the file is not available, one is created.

$ hass --script ensure_config

{% linkable_title Secrets %}

There is a method to store secrets outside of your configuration.yaml file. For further details, please refer to the Storing Secrets documentation.

$ hass --script keyring

{% linkable_title Benchmark %}

For testing the performance of Home Assistant the Benchmark script runs until you exit using Control+C.

Firing and handling of a million events.

$ hass --script benchmark async_million_events

{% linkable_title Old scripts %}

Usually those scripts were only used when a massive update happened and was announced in the release notes.

  • db_migrator: Migrate an existing SQLite database to the new schema.
  • influxdb_migrator: Convert an old InfluxDB to the new format.