npmpackage.info

@percy/client

The Percy CLI is used to interact with, and upload snapshots to, percy.io via the command line.

1.30.2

JavaScript

Installations

npm install @percy/client

Pull Requests

Open

6

Total

1,463

Closed

316

Merged

1,141

Issues

Open

22

Total

209

Closed

187

Releases

226

v1.30.3-beta.1

Published on 27 Nov 2024

v1.30.3-beta.0

Published on 26 Nov 2024

v1.30.2

Published on 14 Nov 2024

v1.30.1

Published on 15 Oct 2024

v1.30.0

Published on 07 Oct 2024

v1.29.5-beta.0

Published on 30 Sept 2024

View all 226 releases

Developer

percy

Developer Guide

BETA

Module System

ESM

Min. Node Version

>=14

Typescript Support

No

Node Version

14.21.3

NPM Version

lerna/6.0.1/node@v14.21.3+x64 (linux)

Statistics

71 Stars

1,479 Commits

47 Forks

10 Watching

32 Branches

56 Contributors

Updated on 28 Nov 2024

Languages

JavaScript (99.37%)

TypeScript (0.44%)

Shell (0.19%)

Total Downloads

Cumulative downloads

Total Downloads

58,716,119

Last day

0.1%

71,325

Compared to previous day

Last week

359,645

Compared to previous week

Last month

2.2%

1,467,810

Compared to previous month

Last year

7.7%

19,996,880

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

pako @percy/env @percy/logger

Versions

Percy CLI

The Percy CLI is used to interact with, and upload snapshots to, percy.io via the command line.

Installation
Command Topics
Advanced
Issues
Developing

Installation

1$ npm install --save-dev @percy/cli

Command Topics

percy exec - capture and upload snapshots
percy snapshot - snapshot a static directory or a list of pages
percy upload - upload a static directory of images
percy config - manage configuration files
percy build - interact with Percy builds

Advanced

In addition to the CLI packages, this repo contains core libraries responsible for Percy's CI/CD integrations, Percy API communication, DOM serialization, asset discovery, etc.

@percy/core - performs snapshot asset discovery and uploading
@percy/client - handles communicating with the Percy API
@percy/dom - serializes DOM snapshots
@percy/env - captures CI build environment variables
@percy/config - loads Percy configuration files
@percy/logger - common logger used throughout the CLI
@percy/sdk-utils - shared helpers for JavaScript SDKs
@percy/cli-command - Percy CLI command framework

Issues

For problems directly related to the CLI, add an issue on GitHub.

For other issues, open a support request.

Developing

This project is built with lerna. The core libaries and CLI plugins are located in ./packages. Run yarn to install dependencies after cloning the repo and use the following scripts for various development tasks:

yarn build - build all packages
yarn build:watch - build and watch all packages in parallel
yarn clean - clean up build and coverage output
yarn lint - lint all packages
yarn readme - generate cli commands readme usage
yarn test - run all tests, one package after another
yarn test:coverage - run all tests with coverage, one package after another
yarn global:link - links all packages being developed as global.
- requires yarn build to be run before consuming.
- we can then consume this package using yarn link @percy/[core|cli..]
- Note: linking is only required once, subsequent changes for development requires running build command.
yarn global:unlink - unlinks all packages globally

Individual package scripts can be invoked using yarn's workspace command. For example:

1$ yarn workspace @percy/core test

How to update Chromium revision?

check in Core Package's readme here.

No vulnerabilities found.

10

Maintained

Determines if the project is "actively maintained".

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

9

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

5

SAST

Determines if the project uses static code analysis.

3

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

1

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

Reason

dependency not pinned by hash detected -- score normalized to 1

Details

Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/executable.yml:10: update your workflow using https://app.stepsecurity.io/secureworkflow/percy/cli/executable.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/executable.yml:11: update your workflow using https://app.stepsecurity.io/secureworkflow/percy/cli/executable.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/executable.yml:25: update your workflow using https://app.stepsecurity.io/secureworkflow/percy/cli/executable.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/executable.yml:42: update your workflow using https://app.stepsecurity.io/secureworkflow/percy/cli/executable.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/executable.yml:44: update your workflow using https://app.stepsecurity.io/secureworkflow/percy/cli/executable.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/executable.yml:48: update your workflow using https://app.stepsecurity.io/secureworkflow/percy/cli/executable.yml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/executable.yml:56: update your workflow using https://app.stepsecurity.io/secureworkflow/percy/cli/executable.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/lint.yml:12: update your workflow using https://app.stepsecurity.io/secureworkflow/percy/cli/lint.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/lint.yml:13: update your workflow using https://app.stepsecurity.io/secureworkflow/percy/cli/lint.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/lint.yml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/percy/cli/lint.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:9: update your workflow using https://app.stepsecurity.io/secureworkflow/percy/cli/release.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:10: update your workflow using https://app.stepsecurity.io/secureworkflow/percy/cli/release.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/sdk-regression.yml:35: update your workflow using https://app.stepsecurity.io/secureworkflow/percy/cli/sdk-regression.yml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/sdk-regression.yml:47: update your workflow using https://app.stepsecurity.io/secureworkflow/percy/cli/sdk-regression.yml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/sdk-regression.yml:50: update your workflow using https://app.stepsecurity.io/secureworkflow/percy/cli/sdk-regression.yml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/sdk-regression.yml:60: update your workflow using https://app.stepsecurity.io/secureworkflow/percy/cli/sdk-regression.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/sdk-regression.yml:67: update your workflow using https://app.stepsecurity.io/secureworkflow/percy/cli/sdk-regression.yml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/sdk-regression.yml:85: update your workflow using https://app.stepsecurity.io/secureworkflow/percy/cli/sdk-regression.yml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/sdk-regression.yml:91: update your workflow using https://app.stepsecurity.io/secureworkflow/percy/cli/sdk-regression.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/sdk-regression.yml:102: update your workflow using https://app.stepsecurity.io/secureworkflow/percy/cli/sdk-regression.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/stale.yml:10: update your workflow using https://app.stepsecurity.io/secureworkflow/percy/cli/stale.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:12: update your workflow using https://app.stepsecurity.io/secureworkflow/percy/cli/test.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:13: update your workflow using https://app.stepsecurity.io/secureworkflow/percy/cli/test.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/percy/cli/test.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:31: update your workflow using https://app.stepsecurity.io/secureworkflow/percy/cli/test.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:61: update your workflow using https://app.stepsecurity.io/secureworkflow/percy/cli/test.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:62: update your workflow using https://app.stepsecurity.io/secureworkflow/percy/cli/test.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:65: update your workflow using https://app.stepsecurity.io/secureworkflow/percy/cli/test.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:78: update your workflow using https://app.stepsecurity.io/secureworkflow/percy/cli/test.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/typecheck.yml:12: update your workflow using https://app.stepsecurity.io/secureworkflow/percy/cli/typecheck.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/typecheck.yml:13: update your workflow using https://app.stepsecurity.io/secureworkflow/percy/cli/typecheck.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/typecheck.yml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/percy/cli/typecheck.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/windows.yml:60: update your workflow using https://app.stepsecurity.io/secureworkflow/percy/cli/windows.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/windows.yml:61: update your workflow using https://app.stepsecurity.io/secureworkflow/percy/cli/windows.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/windows.yml:64: update your workflow using https://app.stepsecurity.io/secureworkflow/percy/cli/windows.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/windows.yml:77: update your workflow using https://app.stepsecurity.io/secureworkflow/percy/cli/windows.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/windows.yml:12: update your workflow using https://app.stepsecurity.io/secureworkflow/percy/cli/windows.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/windows.yml:13: update your workflow using https://app.stepsecurity.io/secureworkflow/percy/cli/windows.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/windows.yml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/percy/cli/windows.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/windows.yml:31: update your workflow using https://app.stepsecurity.io/secureworkflow/percy/cli/windows.yml/master?enable=pin
Warn: npmCommand not pinned by hash: scripts/executable.sh:11
Info: 2 out of 36 GitHub-owned GitHubAction dependencies pinned
Info: 2 out of 8 third-party GitHubAction dependencies pinned
Info: 0 out of 1 npmCommand dependencies pinned

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

Security-Policy

Determines if the project has published a security policy.

0

License

Determines if the project has defined a license.

0

Fuzzing

Determines if the project uses fuzzing.

0

Signed-Releases

Determines if the project cryptographically signs release artifacts.

Score

4.6

/10

Last Scanned on 2024-11-18

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More

Other packages similar to @percy/client

@percy/env

1.30.2

This package provides various CI/CD support for Percy by coalescing different environment variables into a common interface for consumption by `@percy/client`.

@percy/core

1.30.2

The core component of Percy's CLI and SDKs that handles creating builds, discovering snapshot assets, uploading snapshots, and finalizing builds. Uses `@percy/client` for API communication, a Chromium browser for asset discovery, and starts a local API se

percy-client

3.9.0

JavaScript API client library for Percy (https://percy.io).

@percy/cli

1.30.2

[![Test](https://github.com/percy/cli/workflows/Test/badge.svg)](https://github.com/percy/cli/actions)