Skip to content
API definitions for Snyk CLI
TypeScript
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github
legacy
.gitignore
.travis.yml
LICENSE
README.md
index.ts
package.json
tsconfig.json
tslint.json

README.md

snyk-cli-interface

Interface definitions for interactions between Snyk CLI and associated components:

  • plugins for analyzing various build systems
  • monitor states sent to snyk.io website

This library should be only imported from Typescript.

The types can be imported in one of the following ways:

  • whole sub-module import from the top level

    import { legacyPlugin as api } from '@snyk/cli-interface'; // use api.InspectOptions

  • "deep import" (discouraged but possible)

    import { InspectOptions } from '@snyk/cli-interface/legacy/plugin';

The npm package does not follow the usual Snyk convention and exports the build files in the root directory, not in dist, to enable "deep imports".

We still have to publish the package using the compiled files, because many tools in Node.js ecosystem assume that published libraries should be always in Javascript.

You can’t perform that action at this time.