open-index/open-npm huggingface dataset:
npm package: @squidlerio/squidler-action-runner
Description: CLI for Squidler Web Testing
Author: Squidlerio
Latest version: 1.0.0

# Squidler Action Runner

A powerful CLI tool for running Squidler web tests in GitHub Actions workflows or locally. This tool provides seamless
integration with Squidler's advanced web testing platform to identify accessibility, functionality, and language issues
in your websites.

## Overview

The Squidler Action Runner allows you to:

- Run comprehensive web tests against your sites
- Generate detailed reports of issues found
- Integrate testing into your CI/CD workflow
- Save results to GitHub Actions job summaries

## Installation

```bash
npm install @squidlerio/squidler-action-runner
```

## Usage

### Basic Command

```bash
npx squidler-action-runner test --apikey YOUR_API_KEY [options]
```

### Options

- `--apikey` (required): Your Squidler Site API Key
- `--duration`: Test duration in seconds (default: 10)
- `--api-endpoint`: Override Squidler GraphQL API endpoint (advanced)
- `--subscription-endpoint`: Override Squidler WebSocket subscription endpoint (advanced)
- `--no-tunnel`: Disable local tunneling (for testing public URLs directly)
- `--fail-on-problems`: Exit with code 1 if any problems are found
- `--fail-on-new-problems`: Exit with code 1 if any new problems are found
- `--include-recreations`: Include recreations in the test (default: true)
- `--suites`: List of test suites to run (e.g., Accessibility, Functionality, Language)

## GitHub Actions Integration

Add Squidler testing to your GitHub Actions workflow:

```yaml
name: Squidler Web Test

on:
  push:
    branches: [ main ]
  pull_request:
    branches: [ main ]

jobs:
  squidler-test:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3

      - name: Run Squidler Test
        run: npx squidler-action-runner test --apikey ${{ secrets.SQUIDLER_API_KEY }}
```

## Output

The tool outputs:

- Summary of found problems
- Detailed description of each issue
- URLs where problems were found
- GitHub Actions summary with clickable links to the Squidler dashboard

## Local Development

```bash
# Clone the repository
git clone <repository-url>

# Install dependencies
npm install

# Build the project
npm run build

# Run locally
npx ts-node src/squidler-action-runner.ts test --apikey YOUR_API_KEY [options]
```

## About Squidler

Squidler is a comprehensive web testing platform that helps teams identify accessibility, functionality, and language
issues in websites. Visit [www.squidler.io](https://www.squidler.io) to learn more.

## License

This project is licensed under the Apache License, Version 2.0.