diff --git a/source/_docs/tools.markdown b/source/_docs/tools.markdown index a82ca8f43b1..5bdf3eb0dda 100644 --- a/source/_docs/tools.markdown +++ b/source/_docs/tools.markdown @@ -9,4 +9,5 @@ sharing: true footer: true --- -Home Assistant ships a couple of helpers for the command-line and the frontend which simplify common tasks, are helping with migrations, and ensure that Home Assistant runs properly. +Home Assistant ships a couple of helpers for the command-line and the frontend which simplify common tasks, are helping with migrations, and ensure that Home Assistant runs properly. + diff --git a/source/_docs/tools/dev-tools.markdown b/source/_docs/tools/dev-tools.markdown index a82ca8f43b1..f6e9cc6f631 100644 --- a/source/_docs/tools/dev-tools.markdown +++ b/source/_docs/tools/dev-tools.markdown @@ -1,12 +1,25 @@ --- layout: page -title: "Tools" -description: "Description of tools which helps when using Home Assistant." -release_date: 2016-11-13 15:00:00 +title: "Development Tools" +description: "Description of the Developer Tools." +release_date: 2017-02-23 11:00:00 sidebar: true comments: false sharing: true footer: true --- -Home Assistant ships a couple of helpers for the command-line and the frontend which simplify common tasks, are helping with migrations, and ensure that Home Assistant runs properly. +The frontend contains a section called "Developer Tools". + +

+ +Screenshot of Home Assistant's Developer Tools. +

+ +| Section | description | +| ------- | ----- | +| Services | Calls services from components | +| States | Sets the representation of an entity | +| Events | Fires events | +| Templates | Renders templates | +| Info | Details about Home Assistant | diff --git a/source/_docs/tools/hass.markdown b/source/_docs/tools/hass.markdown index a00c68c5bd6..29939a17f11 100644 --- a/source/_docs/tools/hass.markdown +++ b/source/_docs/tools/hass.markdown @@ -1,15 +1,15 @@ --- layout: page -title: "Hass" -description: "Description of tools which helps when using Home Assistant." -release_date: 2016-11-13 15:00:00 +title: "hass" +description: "Description of hass." +release_date: 2017-02-23 11:00:00 sidebar: true comments: false sharing: true footer: true --- -The command-line part of Home Assistant is +The command-line part of Home Assistant is `hass`. ```bash @@ -41,3 +41,5 @@ optional arguments: --script ... Run one of the embedded scripts --daemon Run Home Assistant as daemon ``` + + diff --git a/source/_docs/tools/scripts.markdown b/source/_docs/tools/scripts.markdown index a82ca8f43b1..240c9a4484e 100644 --- a/source/_docs/tools/scripts.markdown +++ b/source/_docs/tools/scripts.markdown @@ -2,11 +2,43 @@ layout: page title: "Tools" description: "Description of tools which helps when using Home Assistant." -release_date: 2016-11-13 15:00:00 +release_date: 2017-02-23 11:00:00 sidebar: true comments: false sharing: true footer: true --- -Home Assistant ships a couple of helpers for the command-line and the frontend which simplify common tasks, are helping with migrations, and ensure that Home Assistant runs properly. +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 with Home Assistant's [script](/docs/scripts/) 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. + +```bash +$ hass --script check_config +``` + +### {% linkable_title Existance of configuration %} + +This script checks if the `configuration.yaml` file exists. If the file is not available, one is created. + +```bash +$ 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](/docs/configuration/secrets/) documentation. + +```bash +$ hass --script keyring +``` + +### {% linkable_title Old scripts %} + +Usally those scripts were only use when a massive update happend 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. diff --git a/source/_includes/asides/docs_navigation.html b/source/_includes/asides/docs_navigation.html index 59a3e6f813d..e73c3c5177d 100644 --- a/source/_includes/asides/docs_navigation.html +++ b/source/_includes/asides/docs_navigation.html @@ -33,7 +33,6 @@
  • {% active_link /docs/configuration/basic/ Basic information %}
  • {% active_link /docs/configuration/devices/ Setting up devices %}
  • {% active_link /docs/configuration/customizing-devices/ Customizing devices and services %}
    • -
  • {% active_link /docs/configuration/presence-detection/ Presence Detection %}
  • {% active_link /docs/configuration/troubleshooting/ Troubleshooting %}
  • {% active_link /docs/configuration/securing/ Security Check Points %}
    • @@ -85,6 +84,14 @@
  • {% active_link /docs/scripts/conditions/ Conditions %}
    • +
  • + {% active_link /docs/tools/ Tools and Helpers %} + +
  • {% active_link /docs/z-wave/ Z-Wave %}