socket scan

You can create a Scan, view a Scan, view the diff of two scans, and get a report relative to your organization's security policy and license policy.

Scan related commands

  Usage
    $ socket scan <command>

  Commands
    create            Create a scan
    del               Delete a scan
    list              List the scans for an organization
    metadata          Get a scan's metadata
    report            Check whether a scan result passes the organizational policies
                      (security, license)
    view              View the raw results of a scan

  Options
    --help            Print this help

  Examples
    $ socket scan --help

To create a new Scan on a given project folder, run socket scan create on that folder. Without further arguments it should ask you to confirm the organization and whether you want to use the current directory. In subsequent runs it should give you an example of how to run the same command without interactive prompts, something like socket scan create beardev .. You can also set the repository name, the branch name, whether this is the default branch, and whether this Scan should show up on your dashboard at all.

You can get a list of latest Scans made in your organization through socket scan list.

Given a Scan ID you can;

• Delete it (socket scan delete)
• View a fairly raw representation of it (socket scan view)
• View a report of it (socket scan report)
• Get the metadata from a report (socket scan metadata).

Note that these commands support

• --json for a raw payload (which you can forward to jq)
• --markdown for easy sharing