Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 17 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Kuality CLI

Scan any website for accessibility, performance, SEO, cross-browser, stress testing, and 30+ QA dimensions — from your terminal.
Test any website for accessibility, performance, SEO, cross-browser, stress testing, and 30+ QA dimensions — from your terminal.

## Install

Expand All @@ -24,28 +24,28 @@ go install github.com/kuality-io/cli@latest
# Authenticate with your API key (get one at https://kuality.io/settings/api-keys)
kuality auth login

# Run a scan
kuality scan example.com
# Run a test
kuality test example.com

# Run a specific scan type
kuality scan example.com --type a11y
# Run a specific test type
kuality test example.com --type a11y

# Fail CI if high-severity findings exist
kuality scan example.com --type a11y --fail-on high
kuality test example.com --type a11y --fail-on high

# JSON output for scripting
kuality scan example.com --format json
kuality test example.com --format json

# JUnit XML for CI test reporting
kuality scan example.com --format junit > results.xml
kuality test example.com --format junit > results.xml
```

## Commands

| Command | Description |
|---------|-------------|
| `kuality scan <url>` | Run a quality scan |
| `kuality status <scan-id>` | Check scan status |
| `kuality test <url>` | Run a quality test |
| `kuality status <test-id>` | Check test status |
| `kuality reports list` | List recent reports |
| `kuality reports show <id>` | Show report details |
| `kuality targets` | List configured targets |
Expand All @@ -54,9 +54,9 @@ kuality scan example.com --format junit > results.xml
| `kuality auth status` | Check auth status |
| `kuality auth logout` | Remove stored API key |

## Scan types
## Test types

37 scan types across 8 categories:
37 test types across 8 categories:

| Category | Types |
|----------|-------|
Expand All @@ -74,9 +74,9 @@ kuality scan example.com --format junit > results.xml
### GitHub Actions

```yaml
- name: Quality scan
- name: Quality test
run: |
kuality scan ${{ vars.SITE_URL }} --type a11y --fail-on high --format junit > kuality-results.xml
kuality test ${{ vars.SITE_URL }} --type a11y --fail-on high --format junit > kuality-results.xml

- name: Upload results
uses: actions/upload-artifact@v4
Expand All @@ -88,9 +88,9 @@ kuality scan example.com --format junit > results.xml
### GitLab CI

```yaml
quality_scan:
quality_test:
script:
- kuality scan $SITE_URL --type a11y --fail-on high --format junit > kuality-results.xml
- kuality test $SITE_URL --type a11y --fail-on high --format junit > kuality-results.xml
artifacts:
reports:
junit: kuality-results.xml
Expand All @@ -100,7 +100,7 @@ quality_scan:

```bash
export KUALITY_API_KEY="your-key"
kuality scan example.com --type a11y --fail-on high --quiet
kuality test example.com --type a11y --fail-on high --quiet
```

Exit codes: `0` = pass, `1` = findings exceed `--fail-on` threshold.
Expand Down
12 changes: 6 additions & 6 deletions cmd/reports.go
Original file line number Diff line number Diff line change
Expand Up @@ -16,13 +16,13 @@ var (

var reportsCmd = &cobra.Command{
Use: "reports",
Short: "View scan reports",
Short: "View test reports",
}

var reportsListCmd = &cobra.Command{
Use: "list",
Short: "List recent reports",
Long: `List recent scan reports for your organization.
Long: `List recent test reports for your organization.

Examples:
kuality reports list
Expand Down Expand Up @@ -64,7 +64,7 @@ Examples:
rows[i] = []string{
id,
r.Target,
r.TypeOfScan,
r.TypeOfTest,
fmt.Sprintf("%s %s", output.StatusIcon(r.State), r.State),
r.Score.String(),
output.SeverityColor("high", r.High),
Expand All @@ -80,7 +80,7 @@ Examples:
var reportsShowCmd = &cobra.Command{
Use: "show <report-id>",
Short: "Show detailed report",
Long: `Show the full details of a scan report.
Long: `Show the full details of a test report.

Examples:
kuality reports show abc123
Expand Down Expand Up @@ -119,7 +119,7 @@ Examples:
fmt.Println()
fmt.Printf(" Report ID: %s\n", report.ID)
fmt.Printf(" Target: %s\n", report.Target)
fmt.Printf(" Scan type: %s\n", report.TypeOfScan)
fmt.Printf(" Test type: %s\n", report.TypeOfTest)
fmt.Printf(" Score: %s\n", report.Score)
fmt.Printf(" Status: %s %s\n", output.StatusIcon(report.State), report.State)
if report.StartDate != "" {
Expand Down Expand Up @@ -149,7 +149,7 @@ Examples:
}

func init() {
reportsListCmd.Flags().StringVarP(&flagReportType, "type", "t", "", "Filter by scan type")
reportsListCmd.Flags().StringVarP(&flagReportType, "type", "t", "", "Filter by test type")
reportsListCmd.Flags().StringVar(&flagReportTarget, "target", "", "Filter by target URL")

reportsCmd.AddCommand(reportsListCmd)
Expand Down
6 changes: 3 additions & 3 deletions cmd/root.go
Original file line number Diff line number Diff line change
Expand Up @@ -21,10 +21,10 @@ var (

var rootCmd = &cobra.Command{
Use: "kuality",
Short: "Kuality CLI — scan any site from your terminal",
Long: `Kuality CLI lets you run website quality scans from the command line.
Short: "Kuality CLI — test any site from your terminal",
Long: `Kuality CLI lets you run website quality tests from the command line.

Scan for accessibility, performance, SEO, cross-browser compatibility,
Test for accessibility, performance, SEO, cross-browser compatibility,
and 30+ other quality dimensions. Integrate into CI/CD pipelines with exit codes
and JUnit output.

Expand Down
2 changes: 1 addition & 1 deletion cmd/score.go
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ Examples:
}

if len(scores) == 0 {
fmt.Println("No scores available. Run a scan first.")
fmt.Println("No scores available. Run a test first.")
return nil
}

Expand Down
12 changes: 6 additions & 6 deletions cmd/status.go
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,9 @@ import (
)

var statusCmd = &cobra.Command{
Use: "status <scan-id>",
Short: "Check the status of a scan",
Long: `Check the current status of a previously started scan.
Use: "status <test-id>",
Short: "Check the status of a test",
Long: `Check the current status of a previously started test.

Examples:
kuality status abc123
Expand All @@ -29,9 +29,9 @@ Examples:
return err
}

status, err := c.GetScanStatus(args[0])
status, err := c.GetTestStatus(args[0])
if err != nil {
return fmt.Errorf("failed to get scan status: %w", err)
return fmt.Errorf("failed to get test status: %w", err)
}

if flagFormat == "json" {
Expand All @@ -43,7 +43,7 @@ Examples:
state = status.State
}

fmt.Printf("Scan ID: %s\n", status.ScanID)
fmt.Printf("Test ID: %s\n", status.TestID)
fmt.Printf("Report ID: %s\n", status.ReportID)
fmt.Printf("Target: %s\n", status.Target)
fmt.Printf("Status: %s %s\n", output.StatusIcon(state), state)
Expand Down
2 changes: 1 addition & 1 deletion cmd/targets.go
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ import (
var targetsCmd = &cobra.Command{
Use: "targets",
Short: "List configured targets",
Long: `List all scan targets configured in your organization.
Long: `List all test targets configured in your organization.

Examples:
kuality targets
Expand Down
Loading