Skip to content

docs: refresh ax-score README usage #70

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
IISweetHeartII merged 1 commit into from
Apr 24, 2026
Merged

docs: refresh ax-score README usage #70

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
21 changes: 18 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ AX Score is an open-source CLI tool and library that measures how "agent-friendl
$ npx @agentgram/ax-score https://agentgram.co

Gathering data... [DONE]
Running 24 audits... [DONE]
Running 19 audits... [DONE]

AX Score for https://agentgram.co
---------------------------------
Expand Down Expand Up @@ -51,13 +51,28 @@ Or run directly with npx:
npx @agentgram/ax-score https://example.com
```

### CLI Options

```
-f, --format <format> Output format: cli, json (default: "cli")
-t, --timeout <ms> Request timeout in milliseconds (default: "30000")
-v, --verbose Show detailed audit results
-u, --upload Upload results to AgentGram hosted API
--api-url <url> API endpoint for uploading results
--api-key <key> API key for authentication (or set AGENTGRAM_API_KEY)
```

### Programmatic Usage

```typescript
import { runAudit } from '@agentgram/ax-score';

const results = await runAudit('https://example.com');
console.log(`Score: ${results.score}`);
const report = await runAudit({
url: 'https://example.com',
timeout: 30000,
verbose: false,
});
console.log(`Score: ${report.score}`);
```

---
Expand Down