globaldex-cli
v1.0.0
Published
CLI tool to scan websites for AI agent readiness. Integrates with CI/CD pipelines.
Maintainers
Readme
GlobalDex CLI
Scan any website for AI agent readiness from the command line.
Install
npm install -g globaldex-cliOr use directly with npx:
npx globaldex-cli https://example.comUsage
# Scan a URL
globaldex scan https://stripe.com
# Scan with shorthand (auto-detects URLs)
globaldex https://stripe.com
# Get JSON output
globaldex scan https://example.com --json
# CI/CD threshold — exit code 1 if score < 70
globaldex scan https://mysite.com --threshold 70
# Lookup an existing scan
globaldex lookup stripe.com
# Get badge embed code
globaldex badge stripe.comCommands
| Command | Description |
| --- | --- |
| scan <url> | Run a fresh scan on a URL |
| lookup <domain> | Retrieve the latest cached scan for a domain |
| badge <domain> | Output Markdown/HTML embed code for a score badge |
Options
| Flag | Description |
| --- | --- |
| --json | Output raw JSON instead of formatted report |
| --threshold <n> | Exit with code 1 if score is below n (CI/CD) |
| --help | Show help |
Environment Variables
| Variable | Description |
| --- | --- |
| GLOBALDEX_API_KEY | API key for higher rate limits |
| GLOBALDEX_API_URL | Custom API base URL (default: https://globaldex.ai) |
CI/CD Usage
GitHub Actions
- name: Check Agent Readiness
run: npx globaldex-cli scan ${{ env.SITE_URL }} --threshold 70
env:
GLOBALDEX_API_KEY: ${{ secrets.GLOBALDEX_API_KEY }}GitLab CI
agent-readiness:
image: node:20-alpine
script:
- npx globaldex-cli scan $SITE_URL --threshold 70License
MIT
