@argos-ci/core
    Preparing search index...

    Interface Config

    interface Config {
        apiBaseUrl: string;
        branch: string;
        buildName: string | null;
        ciProvider: string | null;
        commit: string;
        jobId: string | null;
        mode: "ci" | "monitoring" | null;
        originalRepository: string | null;
        parallel: boolean;
        parallelIndex: number | null;
        parallelNonce: string | null;
        parallelTotal: number | null;
        prBaseBranch: string | null;
        previewBaseUrl: string | null;
        prHeadCommit: string | null;
        prNumber: number | null;
        referenceBranch: string | null;
        referenceCommit: string | null;
        repository: string | null;
        runAttempt: number | null;
        runId: string | null;
        skipped?: boolean;
        threshold: number | null;
        token: string | null;
    }
    Index

    Properties

    apiBaseUrl branch buildName ciProvider commit jobId mode originalRepository parallel parallelIndex parallelNonce parallelTotal prBaseBranch previewBaseUrl prHeadCommit prNumber referenceBranch referenceCommit repository runAttempt runId skipped? threshold token

    Properties

    apiBaseUrl: string

    Base URL of the Argos API. Use this to target a self-hosted installation.

    "https://api.argos-ci.com/v2/"
    branch: string

    Git branch name of the build.

    "main", "develop", "release/1.0"
    buildName: string | null

    Custom build name. Useful for multi-build setups on the same commit.

    ciProvider: string | null

    Name of the detected CI provider (if available).

    "github-actions", "gitlab-ci", "circleci"
    commit: string

    Git commit SHA.

    jobId: string | null

    CI job identifier (if provided by the CI environment).

    mode: "ci" | "monitoring" | null

    Build mode to use.

    • "ci": Review visual changes introduced by a feature branch and prevent regressions.
    • "monitoring": Track visual changes outside the standard CI flow, either on a schedule or before a release.

    https://argos-ci.com/docs/build-modes

    originalRepository: string | null

    Repository slug of the original (base) repository. Example: "my-org/my-repo" or "my-user/my-repo". If from a fork, this refers to the base repository.

    parallel: boolean

    Whether this build is split across multiple parallel jobs.

    false
    parallelIndex: number | null

    Index of the current parallel job. Must be between 1 and parallelTotal, or null if not set.

    parallelNonce: string | null

    Unique identifier shared by all parallel jobs.

    parallelTotal: number | null

    Total number of parallel jobs. Use -1 if unknown, or null if not set.

    prBaseBranch: string | null

    Pull request base branch (if available).

    previewBaseUrl: string | null

    Base URL to use for preview links.

    "https://my-preview.example.com"
    prHeadCommit: string | null

    Pull request head commit SHA (if available).

    prNumber: number | null

    Pull request number associated with the build.

    referenceBranch: string | null

    Git branch used as the baseline for screenshot comparison.

    referenceCommit: string | null

    Git commit SHA used as the baseline for screenshot comparison.

    repository: string | null

    Repository slug of the source repository. Example: "my-org/my-repo" or "my-user/my-repo". If from a fork, this refers to the fork repository.

    runAttempt: number | null

    CI run attempt number (if provided by the CI environment).

    runId: string | null

    CI run identifier (if provided by the CI environment).

    skipped?: boolean

    Skip this build. No screenshots are uploaded, and the commit status is marked as success.

    threshold: number | null

    Diff sensitivity threshold between 0 and 1. Higher values make Argos less sensitive to differences.

    token: string | null

    Argos repository access token.

    Settings

    Member Visibility

    On This Page

    Properties