@refactr/cli v2.0.1

Sophos Factory CLI

The Sophos Factory command line tool is used to interact with the Sophos Factory Platform API from the command line.

Basic usage and installation is described below. Click here for complete Sophos Factory CLI documentation.

Usage

$ refactrctl --help   
Usage: refactrctl <command> [options]

Commands:
  refactrctl run             Execute pipeline or job
  refactrctl rerun [run-id]  Reschedule pipeline run
  refactrctl delete          Delete specified resource
  refactrctl list            List specified resources
  refactrctl get             Get specified resource
  refactrctl create          Create specified resource

Options:
      --version     Show version number                                                                        [boolean]
  -v, --verbose     Print detailed output                                                                      [boolean]
      --format      Output format                                    [choices: "wide", "json", "yaml"] [default: "wide"]
      --filter      Filter output using JsonPath                                                                [string]
      --address     Address of the Sophos Factory API server
                    [string] [default: FACTORY_ADDRESS environment variable if set, otherwise https://api.refactr.it/v1]
      --auth-token  Authentication token                     [string] [default: FACTORY_AUTH_TOKEN environment variable]
      --help        Show help                                                                                  [boolean]

Installation

Binary

We provide official binaries for Linux and macOS. Get the latest version from this page, and download the archive file for your operating system/architecture. Unpack the archive, and put the binary somewhere in your $PATH (e.g. on UNIX-y systems /usr/local/bin). Make sure it has execution permission granted.

npm

To get the latest version of the CLI tool, use npm:

$ npm install @refactr/cli -g

or with yarn:

$ yarn global add @refactr/cli

Global installation is required.

Docker

The CLI available on Docker Hub as well:

$ docker pull refactr/cli

License

Sophos Factory CLI is MIT licensed.

Terms of Use

Please see Sophos Services Agreement and Sophos Privacy Notice.