tegrus-cli

Utility commands used by Tegrus. Cross-platform.

Install

Using pnpm:

1pnpm add -g @tegrus-cli

Using npm:

1npm i -g @tegrus-cli

Usage

After installation, the cli will be available via the tegrus command name:

❯ tegrus --help

  Usage: tegrus [options] [command]

  Tegrus CLI with utilities like: deployments, etc

  Options:
    -V, --version   output the version number
    -h, --help      display help for command

  Commands:
    kubernetes
    s3
    help [command]  display help for command

Commands

Kubernetes

Utility commands for interacting with kubernetes.

Deploy command

❯ tegrus kubernetes deploy --help

  Usage: tegrus kubernetes deploy [options]

  Deploy docker images to kubernetes

  Options:
    -n, --namespace <string>     The kubernetes namespace
    -r, --resource <string>      The kubernetes resource name
    -t, --type <type>            The kubernetes resource type [deployment, statefulset]
    -i, --image <string>         The image name to update
    -o, --host <string>          Kubernetes host name
    -a, --access-token <string>  Kubernetes user access token
    -s, --skip-check             Skip deployment check (default: false)
    --dry-run                    Dry run deployment (default: false)
    --sleep <miliseconds>        Time between statuses check in ms (default: 5000)
    --timeout <seconds>          Script timeout in seconds (default: 30)
    --verbose                    Log aditional info and errors (default: false)
    -h, --help                   display help for command

---

S3

Utility commands for interacting with any S3-compatible object storage, such as AWS S3, Digital Ocean Spaces, etc.

Sync command

❯ tegrus s3 sync --help

  Usage: tegrus s3 sync [options]

  Sync source and destination folder. Local and S3 paths can be used

  Options:
    -s, --source <string>         Source path
    -t, --target <string>         Destination path
    -e, --spaces-key <string>     Digital ocean spaces key
    -r, --spaces-secret <string>  Digital ocean spaces secret
    -d, --del                     To delete non-existing files on destination (default: false)
    -a, --acl                     Set objects ACL <string>
    --dry-run                     Dry run deployment (default: false)
    --verbose                     Log aditional info and errors (default: false)
    -h, --help                    display help for command

---

Usage via npx

npx @tegrus/cli [command] [options]

The cli can be used directly via npx, like in the following gitlab-ci.yml snippet:

1deploy:
2  stage: deploy
3  image: node:18-alpine
4  only:
5    - tags
6  when: manual
7  needs:
8    - build
9  script:
10    - >
11      npx @tegrus/cli@3 s3 sync
12      --source ./dist 
13      --target s3://cdn-isc.tegrus.io
14      --spaces-key $SPACES_KEY
15      --spaces-secret $SPACES_SECRET

Or

1.deploy_kubernetes:
2  stage: deploy
3  image: node:18-alpine
4  script:
5    - >
6      npx @tegrus/cli@3 kubernetes deploy
7      --namespace $DEPLOY_NAMESPACE
8      --resource $DEPLOY_RESOURCE
9      --type deployment
10      --image $CI_REGISTRY_IMAGE:$CONTAINER_TAG
11      --host $KUBERNETES_PROD_HOST
12      --access-token $KUBERNETES_PROD_ACCESS_TOKEN