Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/twingate-labs/tg-cli
Command Line Interface for Administering Twingate
https://github.com/twingate-labs/tg-cli
cloud deno javascript twingate
Last synced: about 1 month ago
JSON representation
Command Line Interface for Administering Twingate
- Host: GitHub
- URL: https://github.com/twingate-labs/tg-cli
- Owner: Twingate-Labs
- License: apache-2.0
- Created: 2022-01-10T18:16:36.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-02-13T11:50:48.000Z (10 months ago)
- Last Synced: 2024-08-03T21:02:49.324Z (5 months ago)
- Topics: cloud, deno, javascript, twingate
- Language: JavaScript
- Homepage:
- Size: 432 KB
- Stars: 23
- Watchers: 6
- Forks: 4
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
- awesome-hcloud - tg-cli
README
Twingate CLI Tool
===========================
This is a command line application demonstrating various usages of the Twingate API.
Setup
===========================
* Download the lastest [release](https://github.com/Twingate-Labs/tg-cli/releases/latest) 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](https://deno.land/#installation) 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](https://graphviz.gitlab.io) package to be [installed](https://graphviz.gitlab.io/download/#executable-packages) 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](https://github.com/Twingate-Labs/tg-cli/issues/new).