@synanetics/syntegr8-cli

Syntegr8 CLI

This is the CLI tool used to interact with the Syntegr8 Engine.

Commands

• auth: Authenticate with Syntegr8 Server
• config [option] Manage Syntegr8 Server profiles: list, set, create, remove.
  • config list - list available profiles
  • config set - set default profile
  • config create - create a new profile
  • config remove - remove a profile
• queue: Get list of queues currently in use by Syntegr8 Server
• request: Get list of requests made to Syntegr8 Server
• server-token Generate a server bearer token to interact manually with Syntegr8 Server. This is used for requests where the user is not present.
• token Generate bearer token to interact manually with Syntegr8 Server

Usage

Install

• Run npm i -g @synanetics/syntegr8-cli

Update

• Run npm update -g @synanetics/syntegr8-cli

Running locally

• replace references to syntegr8 command with node . in the CLI directory

Development

NB: Please refer to project specific settings, the below values are an example and may not work with all syntegr8 instances

1. Run syntegr8 config create
   • Set Name as dev
   • Set Authentication Server URL as http://localhost:8001
   • Set API Server URL as http://localhost:8002
2. Run syntegr8 config set
   • Set your dev profile as your default profile
3. Run syntegr8 auth
4. Run syntegr8 request

Connecting To Sandpit

1. Run syntegr8 config create
   • Set Name as sandpit
   • Set Authentication Server URL as http://localhost:8051
   • Set API Server URL as http://localhost:8052

• In separate terminals run
  • gcloud container clusters get-credentials sandpit-pie-autopilot-cluster --region europe-west2 --project sandpit-pie && kubectl port-forward $(kubectl get pod --selector="component=management-auth" --output jsonpath='{.items[0].metadata.name}') 8051:8080
  • gcloud container clusters get-credentials sandpit-pie-autopilot-cluster --region europe-west2 --project sandpit-pie && kubectl port-forward $(kubectl get pod --selector="component=management" --output jsonpath='{.items[0].metadata.name}') 8052:8080
• Run commands with the -p sandpit flag (or use syntegr8 config set to change your default profile to sandpit)