Twingate CLI Tool

This is a command line application demonstrating various usages of the Twingate API.

Setup

• Download the lastest release cli-{version}-{os}-{cpu architecture}.zip
• Unzip the downloaded zip file

Windows

• Open Command Prompt
• Test
  • \path\to\tg.exe --help e.g. G:\tg.exe --help or
  • cd \path\to\tg.exe followed by tg.exe --help

Linux

• Open Linux Terminal
• Test
  • /path/to/tg --help e.g. /apps/tg --help or
  • cd \path\to\tg followed by ./tg --help

Mac

• Open Mac Terminal
• Execute xattr -d com.apple.quarantine /path/to/tg to remove the quarantine bit.
• Execute chmod +x /path/to/tg to make the app executable.
• Test
  • /path/to/tg --help e.g. /apps/tg --help or
  • cd \path\to\tg followed by ./tg --help

Compiling from source

• Ensure deno is installed
• Execute the commands below

  deno bundle --unstable --import-map ./import_map.json ./tg.js ./tg.bundle.js
  deno compile --allow-all --unstable --target x86_64-unknown-linux-gnu --output ./tg ./tg.bundle.js &

Example Commands

Show command usage

./tg --help

./tg group --help

./tg export --help

Export Excel file

./tg export

Export PNG image

./tg export --format png

Note: Requires the GraphViz package to be installed and available on your path.

List resources

./tg resource list

Import Groups, Remote Networks and resources into a new account

./tg import -a [new account name] -nrg -f [path to file to import from (format must be as outputted by the export command)]

Need Help?

If you are experiencing any issues, create a new issue here.