socket report

socket report --help

  Project report related commands

  Usage
    $ socket report <command>

  Commands
    create            Create a project report
    view              View a project report

  Options
    --help            Print this help and exits.
    --version         Prints current version and exits.

  Examples
    $ socket report --help

socket report create --help

  Create a project report

  Usage
    $ socket report create <paths-to-package-folders-and-files>

  Uploads the specified "package.json" and lock files and, if any folder is
  specified, the ones found in there. Also includes the complementary
  "package.json" and lock file to any specified. Currently "package-lock.json"
  and "yarn.lock" are supported.

  Supports globbing such as "**/package.json".

  Ignores any file specified in your project's ".gitignore", your project's
  "socket.yml" file's "projectIgnorePaths" and also has a sensible set of
  default ignores from the "ignore-by-default" module.

  Options
    ----all           Include all issues
    ----debug         Output debug information
    ----dry-run       Only output what will be done without actually doing it
    ----json          Output result as json
    ----markdown      Output result as markdown
    ----strict        Exits with an error code if any matching issues are found
    ----view          Will wait for and return the created report
    --help            Print this help and exits.
    --version         Prints current version and exits.

  Examples
    $ socket report create .
    $ socket report create '**/package.json'
    $ socket report create /path/to/a/package.json /path/to/another/package.json
    $ socket report create . --view --json

socket report view --help

  View a project report

  Usage
    $ socket report view <report-identifier>

  Options
    --all             Include all issues
    --help            Print this help and exits.
    --json            Output result as json
    --markdown        Output result as markdown
    --strict          Exits with an error code if any matching issues are found
    --version         Prints current version and exits.

  Examples
    $ socket report view QXU8PmK7LfH608RAwfIKdbcHgwEd_ZeWJ9QEGv05FJUQ