Gathering detailed insights and metrics for snyk-api-import
Gathering detailed insights and metrics for snyk-api-import
⚡️Snyk API powered import tool to help you automate & monitor a large scale import into Snyk organizations. Designed for onboarding with a built in queue & retries 📈
Installations
npm install snyk-api-importDeveloper
Developer Guide
BETA
Module System
CommonJS
Min. Node Version
>=20
Typescript Support
Yes
Node Version
20.11.1
NPM Version
10.2.4
Statistics
36 Stars
910 Commits
37 Forks
9 Watching
67 Branches
44 Contributors
Updated on 26 Nov 2024
Languages
TypeScript (99.93%)
JavaScript (0.07%)
Total Downloads
Cumulative downloads
Total Downloads
213,982
Last day
-21%
509
Compared to previous day
Last week
-1.6%
2,907
Compared to previous week
Last month
14.9%
12,954
Compared to previous month
Last year
119.6%
124,832
Compared to previous year
Daily Downloads
Weekly Downloads
Monthly Downloads
Yearly Downloads
Dependencies
20
Dev Dependencies
25
@octokit/types@semantic-release/exec@types/base-64@types/bunyan@types/debug@types/jest@types/lodash@types/micromatch@types/needle@types/node@types/parse-link-header@types/split@typescript-eslint/eslint-plugin@typescript-eslint/parsereslinteslint-config-prettiereslint-plugin-check-filejestnockprettiersemantic-releasets-jesttsc-watchtypescriptuuid
Versions
This repository is in maintenance mode, no new features are being developed. Bug & security fixes will continue to be delivered. Open source contributions are welcome for small features & fixes (no breaking changes)
Snyk helps you find, fix and monitor for known vulnerabilities in your dependencies, both on an ad hoc basis and as part of your CI (Build) system.
snyk-api-import
Snyk API project importer. This script is intended to help import projects into Snyk with a controlled pace utilizing available Snyk APIs.
What does it offer?
rate limiting handling- the script will pace requests to avoid rate limiting from Github/Gitlab/Bitbucket etc and to provide a stable import.queue- requests to Snyk are queued to reduce failures.retries- the script will kick off an import in batches, wait for completion and then keep going. Any failed requests will be retried before they are considered a failure and logged.
If you need to adjust concurrency you can stop the script, change the concurrency variable and start again. It will skip previous repos/targets that have been requested for import.
Table of Contents
-
Utilities
-
Sync: detecting changes in monitored repos and updating Snyk projects
-
Example workflows
Installation
snyk-api-import CLI can be installed through multiple channels.
Standalone executables (macOS, Linux, Windows)
Use GitHub Releases to download a standalone executable of Snyk CLI for your platform.
More installation methods
Install with npm or Yarn
Install with npm or Yarn
Snyk snyk-api-import CLI is available as an npm package. If you have Node.js installed locally, you can install it by running:
1npm install snyk-api-import@latest -g
or if you are using Yarn:
1yarn global add snyk-api-import
Usage
By default the import command will run if no command specified.
import- kick off a an API powered import of repos/targets into existing Snyk orgs defined in import configuration file. 100% support available for all project types supported via Import API.help- show help & all available commands and their optionsorgs:data- util generate data required to create Orgs via API.orgs:create- util to create the Orgs in Snyk based on data file generated withorgs:datacommand.import:data- util to generate data required to kick off an import.list:imported- util to generate data to help skip previously imported targets during import.
The logs can be explored using Bunyan CLI
FAQ
What is the minimum version of Node that the tool supports?
Please check the .nvmrc file for the supported version of Node.
Error: ENFILE: file table overflow, open or Error: EMFILE, too many open files
If you see these errors then you may need to bump ulimit to allow more open file operations. In order to keep the operations more performant tool logs as soon as it is convenient rather than wait until very end of a loop and log a huge data structure. This means depending on number of concurrent imports set the tool may exceed the system default ulimit.
Some of these resources may help you bump the ulimit:
ERROR: HttpError: request to https://github.private.com failed, reason: self signed certificate in certificate chain
If your Github / Gitlab / Bitbucket / Azure is using a self signed certificate, you can configure snyk-api-import to use this certificate when calling the HTTPS APIs.
export NODE_EXTRA_CA_CERTS=./path-to-ca
Does this work with brokered integrations?
Yes. because we reuse the existing integration with your SCM (git) repository to perform the imports, the brokered connection will be used when configured.
What is supported for import command?
snyk-api-import supports 100% of the same integration types and project sources as the Import API documentation. If an example is not in the docs for your use case please see the API documentation
No vulnerabilities found.
No security vulnerabilities found.