Canvass for Security (CFS) Command Reference


Documentation on the Canvass for Security client commands.

Running the Client

Canvass for Security (CFS) commands can be run in two ways:


  1. The command can be run from the command line.
    2. CanvassForSecurity scan /path/to/analyzer/result/file.yml
  2. The command can be run interactively after launching the CFS client.
    3. charlie@hokusai:~/Development$ ./CanvassForSecurity
CanvassForSecurity version 2.0.0, Build 2
Type "help" or "?" for help.

Canvass For Security> scan /path/to/analyzer/result/file.yml

scan

The scan command takes the path to the ORT analyze result as its argument. 

CanvassForSecurity scan /path/to/analyzer/result/file.yml

ORT needs to perform its scan in the project’s operating, build, or testing environment, to properly ascertain your software’s dependencies and their correct version numbers.

get

The get command returns the status of a job. If a job ID isn't provided, then job_number is implicitly equal to the ID of the most recent job. Multiple job IDs can be supplied to the get command to retrieve the status of multiple jobs. 

CanvassForSecurity get job_number

  • If get was called from the command line, then the results for that job will be downloaded automatically to the current directory.
  • If get was called in interactive mode, then you will be prompted to download the results to the current directory.

list

The list command prints your jobs from most recent to oldest, one page at a time. 

  CanvassForSecurity> list

  NUM     STATUS          POSTED TIME             RUN TIME        USER
  --------------------------------------------------------------------------------------------------------------
  25      Completed      2021-07-08 14:49:51     5.24 seconds    charlie@canvasslabs.com
  24      Completed      2021-07-07 22:19:55     6.55 seconds    charlie@canvasslabs.com
  23      Completed      2021-07-07 22:17:19     6.56 seconds    charlie@canvasslabs.com
  22      Aborted         2021-07-07 22:15:34     N/A             charlie@canvasslabs.com
  21      Aborted         2021-07-07 21:41:52     N/A             charlie@canvasslabs.com
  20      Completed      2021-07-07 21:16:08     6.64 seconds    charlie@canvasslabs.com
  19      Completed      2021-07-07 20:51:10     7.92 seconds    charlie@canvasslabs.com
  18      Completed      2021-07-07 20:38:02     6.98 seconds    charlie@canvasslabs.com
  17      Completed      2021-07-07 17:54:06     8.04 seconds    charlie@canvasslabs.com
  16      Completed      2021-07-07 08:10:07     7.52 seconds    charlie@canvasslabs.com
  15      Completed      2021-07-06 22:00:59     7.25 seconds    charlie@canvasslabs.com
  14      Completed      2021-07-06 21:48:49     6.88 seconds    charlie@canvasslabs.com
  13      Completed      2021-07-06 21:33:01     3.78 seconds    charlie@canvasslabs.com
  12      Completed      2021-07-06 21:23:13     3.78 seconds    charlie@canvasslabs.com
  11      Completed      2021-07-06 21:15:16     3.72 seconds    charlie@canvasslabs.com
  10      Completed      2021-07-06 21:06:09     3.79 seconds    charlie@canvasslabs.com
  Press 'Q' to quit, or another key to continue...

abort

The abort command can terminate a job if its status is new, requeued, or processing. If a job ID isn't provided, then the most recent job will attempt to abort. Multiple job IDs can be supplied to abort to attempt to terminate the corresponding jobs.

Jobs can also be aborted from the Jobs Page.

version

The version command lists the version of the CFS client. 

  ./CanvassForSecurity version
CanvassForSecurity version 2.0.0, Build 5

credits

The credits command details the amount of credits left in your account's current billing cycle. 

  ./CanvassForSecurity credits
You are a free tier user.
You have 89 jobs remaining this billing cycle.
Your billing cycle renews at: 2021-10-23 08:59:06

help

The help command lists the CFS client commands. 

  ./CanvassForSecurity help

Documented commands (type help ):
========================================
abort  credits  download  get  help  list  quit  scan  version

quit

The quit command exits interactive mode, if you are currently in it.