@squarefactory/isquare-cli

isquare cli

Installation instructions

Standalone

We distribute the isquare CLI as standalone executable.

• Linux: https://storage.googleapis.com/isquare-artifacts/latest/i2-linux
• Windows: https://storage.googleapis.com/isquare-artifacts/latest/i2-win.exe
• MacOS: https://storage.googleapis.com/isquare-artifacts/latest/i2-macos

Node.js user

If you are using Node.js, you can easily install the CLI with your favorite package manager:

npm install --global @squarefactory/isquare-cli
# yarn global add @squarefactory/isquare-cli  # if using yarn v1
# pnpm install --global @squarefactory/isquare-cli  # if using pnpm

Usage

Most of the commands are discoverable using the --help flag.

Login

In order to use the CLI you need to:

1. create an account on the isquare training platform
2. create a token on the tokens page
3. copy the token (which starts by i2_...) and run the following command:

i2 login <token>

Expected output:

INFO  Logged at [e-mail]

Architecture

• src contains the source code
  • commands the cli subcommands
  • lib miscellaneous functions and routines
  • i2.ts the CLI entrypoint