Code Monkey home page Code Monkey logo

hassio-cli's Introduction

Hass.io CLI

build status

Description

Commandline interface to facilitate interaction with hass.io server

Usage

  • hassio help
  • hassio <subcommand> <action> [<options>]

E.g.

  • hassio homeassistant info --rawjson

Supported endpoints

homeassistant

  • info
  • logs
  • restart
  • start
  • stop
  • update

supervisor

  • info
  • logs
  • reload
  • update

hardware

  • info
  • audio

host

  • reboot
  • shutdown
  • update

network

  • info
  • options

snapshots

  • list
  • info
  • reload
  • new
  • restore
  • remove

Supported modifiers

Global

  • --debug,-d -> Enables debug output

SubCommand

  • --rawjson,-j -> Will return the data in JSON format on a single line (useful for passing to other programs to parse / utilise)
  • --options,-o -> Used to send commands to hass.io hassio homeassistant update --options "version=0.60"
  • --filter,-f -> Used to filter the data returned from hass.io so only the specified properties are output

Note: Modifer order is important.

hassio <GlobalModifier> <SubCommand> <Action> <SubCommandModifier>

Supported builds

  1. i386
  2. x64
  3. arm
  4. arm64

Install

To install, use go get:

$ go get -d github.com/home-assistant/hassio-cli

Contribution

  1. Fork (https://github.com/home-assistant/hassio-cli/fork)
  2. Create a feature branch
  3. Commit your changes
  4. Rebase your local changes against the master branch
  5. Run test suite with the go test ./... command and confirm that it passes
  6. Run gofmt -s
  7. Create a new Pull Request

Building

go test ./...
gox -osarch="linux/arm" -ldflags="-s -w" -output="hassio"
upx --brute hassio

Author

home-assistant

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.