The CLI - Rediverse/eztwitch GitHub Wiki

Getting Started

Installing our CLI

To install, type in this command:

npm i eztw -g

This will install our package as a cli. If it's installed, you can test it by typing eztwitch to your console.

Configuring our CLI

Now we will setup the Client-ID and Secret from your Twitch app console by issuing this command:

eztwitch config -i <Your Client ID> -s <Your Secret> -a

Command reference

Config

eztwitch config

This command allows you to change the config of EZ Twitch.

Parameter Alias Description Syntax
--clear -c Delete everything in the config. -c
--delete -d Delete a parameter from the config. -d <parameter>
--id -id Set the ID of your application -i <client id>
--secret -s Set the Secret of your application -s <client secret>
--show N/A Show the config. If provided, other parameters will be ignored. --show
--token -t Set the token. This is fully optional and is replaced by running the "token" command. -t <token>
--token-autogen -a If you make a request and the token is invalid, eztwitch will automatically request a new one. -a

Token

eztwitch token

Request a new token from Twitch.

Parameter Alias Description Syntax
--config -c Uses the data provided in the config to get a token -c
--debug -d Outputs the request data besides the token -d
--id -i Provide an id (not done yet) -id <id>
--noInfo -n Removes the fancy command line output and returns the token directly. -n
--secret -s Provide a secret (not done yet) -s <secret>
--save N/A After the request the token will be saved to the config. --save

Validating

eztwitch validate

Validate your token from the config.

Create App

eztwitch create-app

Opens a setup interface for a new EZTwitch app. We recommend saving Client ID, Token and Secret to you config so we can automatically insert it to your file.

⚠️ **GitHub.com Fallback** ⚠️