https://github.com/vervallsweg/cast-web-api-cli

https://github.com/vervallsweg/cast-web-api-cli

Last synced: 3 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/vervallsweg/cast-web-api-cli
• Owner: vervallsweg
• License: gpl-3.0
• Created: 2019-05-24T19:23:50.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2022-12-10T15:25:07.000Z (almost 2 years ago)
• Last Synced: 2024-07-12T06:46:24.970Z (4 months ago)
• Language: JavaScript
• Size: 833 KB
• Stars: 19
• Watchers: 5
• Forks: 8
• Open Issues: 21
• Metadata Files:
  • Readme: README.md
  • Changelog: changelog.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# cast-web-api-cli

[![npm version](https://badge.fury.io/js/cast-web-api-cli.svg)](https://badge.fury.io/js/cast-web-api-cli)

[![Dependency Status](https://img.shields.io/david/vervallsweg/cast-web-api-cli.svg)](https://david-dm.org/vervallsweg/cast-web-api-cli)

[![npm](https://img.shields.io/npm/dm/cast-web-api-cli.svg?maxAge=2592000)]()

CLI manager for [cast-web-api](https://github.com/vervallsweg/cast-web-api).

## Installation

	$ npm install cast-web-api-cli -g

You might run into [issues](https://github.com/vervallsweg/cast-web-api/issues/79) with the optional Google-Assistant integration.

## First steps

    $ cast-web-api-cli start

The server runs on your network ip:3000 by default. On error it defaults to 127.0.0.1. Adjustable via:

	$ cast-web-api-cli start -H 192.168.0.11 -p 8080

## Usage

    $ cast-web-api-cli -h

    

       USAGE

    

         cast-web-api-cli  [options]

    

       COMMANDS

    

         start               Start cast-web-api as daemon           

         stop                Stop the cast-web-api daemon           

         status              Check status of the cast-web-api daemon

         startup             Start the cast-web-api daemon on system startup      

         unstartup           Remove the cast-web-api daemon start on system startup

         fix-perm            Changes permissions on /config to current user

         help       Display help for a specific command    

    

       GLOBAL OPTIONS

    

         -h, --help         Display help                                      

         -V, --version      Display version

### Parameters

Every changed parameter will be saved in `/config/config.json`. The location will be changed in the next release.

### Run on system startup

Enable start cast-web-api on startup.

    $ cast-web-api-cli startup

    

Disable start cast-web-api on startup.

    $ cast-web-api-cli unstartup