appvet
v0.1.0
Published
CLI for AppVet — AI-powered security, accessibility, performance & SEO testing
Maintainers
Readme
AppVet CLI
AI-powered security, accessibility, performance & SEO testing from the command line.
Installation
npm install -g appvetOr use directly with npx:
npx appvet scan https://example.comQuick Start
# Save your API key
appvet login
# Run a full scan
appvet scan https://example.com
# Security + accessibility only, JSON output
appvet scan https://example.com --types security,accessibility --json
# Fail CI if any score below 80
appvet scan https://example.com --threshold 80Commands
appvet scan <url>
Scan a URL and display results.
| Flag | Short | Description | Default |
|------|-------|-------------|---------|
| --types | -t | Comma-separated scan types | security,accessibility,performance,seo |
| --json | -j | Output raw JSON (for piping/CI) | false |
| --threshold | -T | Minimum score — exit code 1 if any scan below | none |
| --wait | -w | Max seconds to wait for completion | 300 |
| --key | -k | API key (overrides env var) | $APPVET_API_KEY |
| --api-url | | API base URL | https://appvet.dev |
appvet usage
Show current credit usage and plan details.
appvet login
Interactive API key setup. Saves to ~/.appvet/config.
appvet --version
Print version number.
appvet --help
Print help and usage information.
Environment Variables
| Variable | Description |
|----------|-------------|
| APPVET_API_KEY | API key (alternative to --key flag or appvet login) |
| NO_COLOR | Disable colored output |
API Key Resolution
The CLI resolves your API key in this order:
--keyflag$APPVET_API_KEYenvironment variable~/.appvet/configfile (saved byappvet login)
CI/CD Integration
GitHub Actions
- name: Install AppVet
run: npm install -g appvet
- name: Run security scan
env:
APPVET_API_KEY: ${{ secrets.APPVET_API_KEY }}
run: appvet scan ${{ env.PREVIEW_URL }} --types security,accessibility --threshold 80JSON Output
Use --json for machine-readable output:
appvet scan https://example.com --json | jq '.scans[] | select(.score < 80)'Exit Codes
| Code | Meaning |
|------|---------|
| 0 | All scans complete, threshold passed (or no threshold) |
| 1 | At least one scan below threshold |
| 2 | Error (invalid key, network failure, scan failed) |
Requirements
- Node.js >= 18.0.0
- Zero npm dependencies
License
MIT - Deep Fortune Inc.
