Node.js SDK

Upload screenshots programmatically from Node.js scripts, or build your own Argos integration with @argos-ci/core.

@argos-ci/core is the low-level SDK every Argos integration builds on. Use it to upload screenshots from your own Node.js scripts or to build a custom integration. It is available as an npm package; the source code is on GitHub.

Installation

npm install --save-dev @argos-ci/core

Usage

To upload screenshots from a ./screenshots directory, use the upload function:

import { upload } from "@argos-ci/core";

await upload({ root: "./screenshots" });

upload accepts the same options as the CLI upload command — files globs, build name, mode, parallel settings, threshold, and more.

API reference

For a detailed breakdown of the available functions and options, see the SDK reference documentation.