@version-tracking/cli NPM

Version Tracking Service - CLI

CLI tool to interact with VTS from CI or local

Usage

$ npm install -g @version-tracking/cli
$ vts COMMAND
running command...
$ vts (-v|--version|version)
@version-tracking/cli/1.0.13 darwin-x64 node-v12.18.1
$ vts --help [COMMAND]
USAGE
  $ vts COMMAND
...

Commands

`vts add-environment`

adds a environment to a project

USAGE
  $ vts add-environment

OPTIONS
  -h, --help                     show CLI help
  -l, --lockstep                 defines if this environment is in lockstep with the project version
  -p, --project=project          project in which the environment is contained
  -s, --environment=environment  environment to be added
  -s, --name=name                environment name
  --vtsUrl=vtsUrl                this option allows you to override the vts url

EXAMPLE
  $ vts add-environment --id my-environment

See code: src/commands/add-environment.ts

`vts add-service`

adds a service to a project

USAGE
  $ vts add-service

OPTIONS
  -h, --help             show CLI help
  -p, --project=project  project in which the service is contained
  -s, --service=service  service to be added
  --vtsUrl=vtsUrl        this option allows you to override the vts url

EXAMPLE
  $ vts add-service --id my-service

See code: src/commands/add-service.ts

`vts create-build-status`

creates a build status for a service or an environment

USAGE
  $ vts create-build-status

OPTIONS
  -b, --buildBranch=buildBranch          branch that is being built
  -b, --buildId=buildId                  version that will be associated with the specified service

  -b, --buildStatus=buildStatus          [default: IN_PROGRESS] can be one of: "NOT_SET", "IN_PROGRESS", "FAILED",
                                         "ABORTED", "SUCCESS", "TIMED_OUT"

  -e, --entity=entity                    entity to have the build status created (can be a service id or an environment
                                         id)

  -h, --buildCommitHash=buildCommitHash  The commit hash for this build

  -h, --help                             show CLI help

  -p, --project=project                  project in which the service is contained

  -t, --type=type                        (required) possible values are "services" or "environments"

  -v, --buildUrl=buildUrl                version that will be associated with the specified service

  --vtsUrl=vtsUrl                        this option allows you to override the vts url

EXAMPLE
  $ vts create-build-status --project my-project --type services --entity serviceId --buildId 1 --buildStatus 
  IN_PROGRESS --buildBranch master --buildUrl https://www.example.com

See code: src/commands/create-build-status.ts

`vts create-health-check-result`

creates a health check result

USAGE
  $ vts create-health-check-result

OPTIONS
  -d, --duration=duration        time taken for the health check to execute
  -e, --environment=environment  environment to which this health check result will be associated
  -h, --help                     show CLI help
  -p, --healthCheck=healthCheck  health check to which this result will be associated
  -p, --project=project          project in which the service is contained
  -s, --status=status            [default: success] status of the health check. can be "success" or "failure"
  -t, --timestamp=timestamp      timestamp when the health check happened
  --vtsUrl=vtsUrl                this option allows you to override the vts url

EXAMPLE
  $ vts create-health-check-result

See code: src/commands/create-health-check-result.ts

`vts create-project`

creates a new project

USAGE
  $ vts create-project

OPTIONS
  -h, --help       show CLI help
  -i, --id=id      The project id. Must be URL compliant and unique among your projects.
  -n, --name=name  The project name. A readable name for your project.
  --vtsUrl=vtsUrl  this option allows you to override the vts url

EXAMPLE
  $ vts create-project --id my-project --name "My Project"

See code: src/commands/create-project.ts

`vts get-version`

get the specified version of a particular project

USAGE
  $ vts get-version

OPTIONS
  -h, --help             show CLI help
  -p, --project=project  project in which the service is contained
  -v, --version=version  version that will be retrieved
  --vtsUrl=vtsUrl        this option allows you to override the vts url

EXAMPLE
  $ vts get-version --project my-project --version 7

See code: src/commands/get-version.ts

`vts help [COMMAND]`

display help for vts

USAGE
  $ vts help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

`vts update-build-status`

updates a build status for a service or an environment

USAGE
  $ vts update-build-status

OPTIONS
  -b, --buildBranch=buildBranch          branch that is being built
  -b, --buildId=buildId                  version that will be associated with the specified service

  -b, --buildStatus=buildStatus          [default: SUCCESS] can be one of: "NOT_SET", "IN_PROGRESS", "FAILED",
                                         "ABORTED", "SUCCESS", "TIMED_OUT"

  -e, --entity=entity                    entity to have the build status created (can be a service id or an environment
                                         id)

  -h, --buildCommitHash=buildCommitHash  The commit hash for this build

  -h, --help                             show CLI help

  -p, --project=project                  project in which the service is contained

  -t, --type=type                        (required) possible values are "services" or "environments"

  -v, --buildUrl=buildUrl                version that will be associated with the specified service

  --vtsUrl=vtsUrl                        this option allows you to override the vts url

EXAMPLE
  $ vts update-build-status --project my-project --type services --entity serviceId --buildId 1 --buildStatus 
  IN_PROGRESS --buildBranch master --buildUrl https://www.example.com

See code: src/commands/update-build-status.ts

`vts version-bump`

bumps the version of a particular service

USAGE
  $ vts version-bump

OPTIONS
  -b, --buildId=buildId                    build id to update

  -d, --buildStatus=buildStatus            [default: SUCCESS] can be one of: "NOT_SET", "IN_PROGRESS", "FAILED",
                                           "ABORTED", "SUCCESS", "TIMED_OUT"

  -h, --help                               show CLI help

  -l, --buildUrl=buildUrl                  version that will be associated with the specified service

  -p, --project=project                    project in which the service is contained

  -r, --buildBranch=buildBranch            branch that is being built

  -s, --service=service                    service to have the version updated

  -u, --updateBuildStatus                  updates the build status

  -v, --version=version                    version that will be associated with the specified service

  --artifactId=artifactId                  Optional ID to be associated with your artifact

  --customArtifact=customArtifact          Arbitraty format JSON object with custom information for your artifact. Must
                                           have between 1 and 10 properties.

  --s3Artifact                             sets s3 artifact information

  --s3ArtifactBucket=s3ArtifactBucket      s3 artifact bucket

  --s3ArtifactChecksum=s3ArtifactChecksum  s3 artifact checksum

  --s3ArtifactKey=s3ArtifactKey            s3 artifact key

  --s3ArtifactRegion=s3ArtifactRegion      s3 artifact bucket region

  --s3ArtifactType=s3ArtifactType          s3 artifact type. Can be "file" or "folder"

  --vtsUrl=vtsUrl                          this option allows you to override the vts url

EXAMPLE
  $ vts version-bump --project my-project --service my-service --version 1.0.0

See code: src/commands/version-bump.ts