Getting Started

Setup

To get started with integrating pods in your project, you need to first install torque cli in your laptop.

curl -o- https://torque-distribution.s3.ap-south-1.amazonaws.com/cli-distribution/0.0.1/install.sh | bash

After the script has successfully run, open a new terminal and run

torque init
? Please enter the registry base url https://api.torque.squareboat.com
? Please enter the access token kjnlk

Once this is done, you can run the below command to see if you are authorized to use the torque command.

torque test

If this step is done, you are good to start now!

Torque comes packed with some common actions which you can use to make your tasks a little easier.

You can run the torque command followed by a action.

torque <action_name>

Action to initialise the setup of torque

torque init
? Please enter the registry base url https://api.torque.squareboat.com
? Please enter the access token abcd1234

Action to add a pod to your project.

cd ~/Sites/my-nestjs-project
torque add-pod pdf-worker --directory libs/pdf-worker --latest

Action to setup a new project from Squareboat's standard boilerplate. Currently supports only NestJS.

torque new-project -n my-new-nestjs-projet

If you are facing any trouble or if the torque is not running as per the expectation, you can use the --help flag to see the available options.

torque --help
torque <action_name> --help