Skip to content

tcmdCLI.md

Latest commit

 

History

History
71 lines (51 loc) · 2.51 KB

tcmdCLI.md

File metadata and controls

71 lines (51 loc) · 2.51 KB

Command Line Interface tool

The tcmd CLI lets you trigger commands on remote computers from a terminal.

Download tcmd

Setup

Linux / Mac / Raspberry Pi

# Example for Linux ARM (Raspberry Pi) — substitute the correct download for your platform
wget https://triggercmdagents.s3.amazonaws.com/tcmd_cli/tcmd-linux-arm
sudo mv tcmd-linux-arm /usr/local/bin/tcmd
chmod +x /usr/local/bin/tcmd

Windows

  1. Rename the downloaded file to tcmd.exe.
  2. Move it to C:\Windows or another folder in your PATH.

Authentication

The first time you run tcmd, you need to authenticate. There are three options:

  1. Pair code — run tcmd --pair and follow the prompts.
  2. Token file — if you have the TRIGGERcmd agent installed, tcmd will automatically find your token at ~/.TRIGGERcmdData/token.tkn.
  3. Environment variable — set TRIGGERCMD_TOKEN to your token value.

tcmd usage

Run this command to get help text:

tcmd -h

NAME:
    tcmd - Run commands on computers in your TRIGGERcmd account
  USAGE:
    tcmd [options]

  OPTIONS:
    --trigger value, -t value   Trigger name of the command you want to run
    --computer value, -c value  Name of the computer (leave blank for your default computer)
    --params value, -p value    Any parameters you want to add to the remote command
    --panel value, -P value     Name of the panel you want to use
    --button value, -b value    Name of the panel button to "press"
    --list, -l                  List your commands
    --listpanels, -L            List your panels
    --pair                      Login using a pair code
    --help, -h                  show help
    --version, -v               print the version

Source code

You can view the Go source code for the tcmd tool on Github here.

Youtube video

To see the tcmd tool in action, check out this Youtube video.