home-assistant.io/source/hassio/commandline.markdown
Franck Nijhof 1833c32a2c Cleans up front matter (#9835)
* Sets front matter defaults

* Removes default front matter from section templates/pages

* Removes default front matter from addon pages

* Removes default front matter from integration pages

* Removes default front matter from posts

* Removes default front matter from docs pages

* Removes default front matter from other pages

* Fixes blog category pages
2019-07-11 14:35:08 -07:00

2.2 KiB

title, description
title description
Hass.io via the Command line Command line utility to control Hass.io.

Hass.io upgrade process from the SSH command line

On the SSH command line, you can use the hassio command to retrieve logs, check the details of connected hardware, and more.

Home Assistant

$ hassio homeassistant info
$ hassio homeassistant logs
$ hassio homeassistant check
$ hassio homeassistant restart
$ hassio homeassistant start
$ hassio homeassistant stop
$ hassio homeassistant update

Supervisor

$ hassio supervisor info
$ hassio supervisor logs
$ hassio supervisor reload
$ hassio supervisor update

Host

$ hassio host reboot
$ hassio host shutdown
$ hassio host update

Hardware

$ hassio hardware info
$ hassio hardware audio

Usage examples

To update Home Assistant to a specific version, use the command:

hassio homeassistant update --version=x.y.z

Replace x.y.z with the desired version like --version=0.74.2

You can get a better description of the CLI capabilities by typing hassio help:

NAME:
   hassio - Commandline tool to allow interaction with hass.io

USAGE:
   hassio [global options] command [command options] [arguments...]

VERSION:
   1.3.1

AUTHOR:
   Home-Assistant <hello@home-assistant.io>

COMMANDS:
     homeassistant, ha  info, logs, check, restart, start, stop, update
     supervisor, su     info, logs, reload, update
     host, ho           reboot, shutdown, update
     hardware, hw       info, audio
     network, ne        info, options
     snapshots, sn      list, info, reload, new, restore, remove
     addons, ad         list, info, logo, changelog, logs, stats,
 reload, start, stop, install, uninstall, update
     help, h  Shows a list of commands or help for one command

GLOBAL OPTIONS:
   --debug, -d    Prints Debug information
   --help, -h     show help
   --version, -v  print the version

Console access

You can also access HassOS via a directly connected keyboard and monitor, the console. To log in to the physical console the username is root, with no password.