Difference between revisions of "TVCli Commands Reference"

From TaticView
Jump to: navigation, search
Line 8: Line 8:
 
Here you can read about the commands and options available for TVCli.
 
Here you can read about the commands and options available for TVCli.
  
 +
==== TVCli get new token ====
 +
 +
This command request the generation of a new '''[[Manage_Access#Tokens|Access TOKEN]]'''.
 +
 +
 +
Command Syntax:
 +
  '''tvcli -cmd get_token_by_password -user <your TaticView user> -password <your TaticView password> [-token_name "<token name>"]'''
 +
 +
-cmd                  - get_token_by_password - The command responsible for requesting and storing the Access TOKEN on the TVCli settings.
 +
  -user                  - Your TaticView user (access e-mail).
 +
  -password              - Your TaticView access password.
 +
  -token_name (optional) - The name you want to set to your Access TOKEN. The default name '''TaticView CLI''' will be set if you do not specify a name.       
 +
 +
Example:
 +
  '''tvcli -cmd get_token_by_password -user myemail@email.com -password 123466 -token_name "TVCli Server 1" '''
  
  
 
==== TVCli show version ====
 
==== TVCli show version ====
 
  
 
You can run the <i>-version</i> command to see which TVCli version is installed on your computer. This command displays the TVCli version on the console and registers it on the TVCli log.
 
You can run the <i>-version</i> command to see which TVCli version is installed on your computer. This command displays the TVCli version on the console and registers it on the TVCli log.

Revision as of 16:13, 7 August 2021

Other languages:
English • ‎português do Brasil

TaticView Commands Reference


Here you can read about the commands and options available for TVCli.

TVCli get new token

This command request the generation of a new Access TOKEN.


Command Syntax:

 tvcli -cmd get_token_by_password -user <your TaticView user> -password <your TaticView password> [-token_name "<token name>"]

-cmd - get_token_by_password - The command responsible for requesting and storing the Access TOKEN on the TVCli settings.

 -user                  - Your TaticView user (access e-mail).
 -password              - Your TaticView access password.
 -token_name (optional) - The name you want to set to your Access TOKEN. The default name TaticView CLI will be set if you do not specify a name.         

Example:

 tvcli -cmd get_token_by_password -user myemail@email.com -password 123466 -token_name "TVCli Server 1" 


TVCli show version

You can run the -version command to see which TVCli version is installed on your computer. This command displays the TVCli version on the console and registers it on the TVCli log.


Command Syntax:

 tvcli -version

TVCli show log

since TVCli version 1.1

You can run the show_logs command to show the log file.

Command Syntax:

 tvcli -cmd show_logs - Show the current day logs
 tvcli -cmd show_logs -all - Show all logs in the logs directory