/hassctl

Simple command line utility to help debug Home Assistant configuration

Primary LanguageShellMIT LicenseMIT

hassctl Flattr this

A command line utility to simplify the management of Home Assistant

Compatibility

This utility has been tested on the following platforms:

  • Raspberry Pi
    • Manual install (with systemd service)
    • AIO/One-Step Installer
    • Hassbian Image
  • Ubuntu Server 16.04.1
    • Manual install (with systemd service)

Installation

sudo curl -o /usr/local/bin/hassctl https://raw.githubusercontent.com/dale3h/hassctl/master/hassctl && sudo chmod +x /usr/local/bin/hassctl

Updating

To update hassctl to the latest stable version, run hassctl update or hassctl update master To update hassctl to the latest dev version, run hassctl update dev

Usage

You can update Home Assistant using:

hassctl update-hass

You can control Home Assistant using:

hassctl start

Start the Home Assistant service

hassctl stop

Stop the Home Assistant service

hassctl restart

Restart the Home Assistance service

hassctl kill

Send a SIGKILL (-9) signal to the Home Assistant service

hassctl log

Follow the Home Assistant logs (errors are highlighted)

hassctl error

Follow the Home Assistant error logs

hassctl config

Run the configuration check script

hassctl update [branch]

Update hassctl to the latest version

Configuration AIO installer user hass '/etc/hassctl.conf' This configuration file works for all AIO installers with user hass

# /etc/hassctl.conf: `hassctl' configuration.
#
# A full description of the configuration file is at
# https://github.com/dale3h/hassctl

HASSCTL_BRANCH=master

VIRTUAL_ENV=/srv/hass
PIP_EXEC=$VIRTUAL_ENV/hass_venv/bin/pip3
HASS_EXEC=$VIRTUAL_ENV/hass_venv/bin/hass

HASS_CONFIG=/home/hass/.homeassistant
HASS_USER=hass
HASS_SERVICE=home-assistant.service