@assay-ai/cli 0.3.0-beta → 1.3.1-beta

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +24 -27
  2. package/package.json +3 -2
package/README.md CHANGED
@@ -1,49 +1,46 @@
1
+ <div align="center">
2
+
1
3
  # @assay-ai/cli
2
4
 
3
- Command-line interface for the [Assay](https://github.com/assay-ai/assay) LLM evaluation framework.
5
+ *Command-line interface for the Assay LLM evaluation framework*
4
6
 
5
- ## Installation
7
+ [![npm version](https://img.shields.io/npm/v/@assay-ai/cli?style=flat-square&color=6366f1)](https://www.npmjs.com/package/@assay-ai/cli)
8
+ [![downloads](https://img.shields.io/npm/dm/@assay-ai/cli?style=flat-square&color=10b981)](https://www.npmjs.com/package/@assay-ai/cli)
9
+ [![License](https://img.shields.io/badge/license-MIT-blue?style=flat-square)](https://github.com/assay-ai/assay/blob/main/LICENSE)
6
10
 
7
- ```bash
8
- npm install -g @assay-ai/cli
9
- # or
10
- pnpm add -g @assay-ai/cli
11
- ```
11
+ [Documentation](https://assay.js.org) · [Metrics](https://assay.js.org/metrics/) · [API Reference](https://assay.js.org/api/)
12
12
 
13
- ## Usage
13
+ </div>
14
14
 
15
- ### Initialize a project
15
+ ## Installation
16
16
 
17
17
  ```bash
18
- assay init
18
+ pnpm add -g @assay-ai/cli # pnpm
19
+ npm install -g @assay-ai/cli # npm
20
+ yarn global add @assay-ai/cli # Yarn
19
21
  ```
20
22
 
21
- Creates an `assay.config.ts` and prints the install command for your detected package manager.
22
-
23
- ### Run evaluations
23
+ ## Quick Start
24
24
 
25
25
  ```bash
26
+ # Initialize a new project (creates assay.config.ts)
27
+ assay init
28
+
26
29
  # Run all *.eval.ts files
27
30
  assay run
28
31
 
29
32
  # Run a specific glob pattern
30
33
  assay run "tests/**/*.eval.ts"
31
34
 
32
- # With a custom reporter
33
- assay run --reporter verbose
34
- ```
35
-
36
- ### List available metrics
37
-
38
- ```bash
35
+ # List all 18 built-in metrics
39
36
  assay list-metrics
40
37
  ```
41
38
 
42
- Prints a formatted table of all built-in metrics with their type (LLM / Non-LLM) and required fields.
43
-
44
- ### Other options
39
+ ## Part of the [Assay](https://github.com/assay-ai/assay) monorepo
45
40
 
46
- ```bash
47
- assay --version
48
- assay --help
49
- ```
41
+ <p align="center">
42
+ <a href="https://assay.js.org"><img src="https://img.shields.io/badge/Documentation-6366f1?style=for-the-badge&logo=readthedocs&logoColor=white" alt="Documentation" /></a>
43
+ <a href="https://www.npmjs.com/package/@assay-ai/cli"><img src="https://img.shields.io/badge/npm-cb3837?style=for-the-badge&logo=npm&logoColor=white" alt="npm" /></a>
44
+ <a href="https://github.com/assay-ai/assay"><img src="https://img.shields.io/badge/GitHub-181717?style=for-the-badge&logo=github&logoColor=white" alt="GitHub" /></a>
45
+ <a href="https://github.com/assay-ai/assay/issues"><img src="https://img.shields.io/badge/Issues-6366f1?style=for-the-badge&logo=github&logoColor=white" alt="Issues" /></a>
46
+ </p>
package/package.json CHANGED
@@ -1,7 +1,8 @@
1
1
  {
2
2
  "name": "@assay-ai/cli",
3
- "version": "0.3.0-beta",
3
+ "version": "1.3.1-beta",
4
4
  "description": "CLI for the Assay LLM evaluation framework",
5
+ "homepage": "https://assay.js.org",
5
6
  "license": "MIT",
6
7
  "type": "module",
7
8
  "bin": {
@@ -12,7 +13,7 @@
12
13
  ],
13
14
  "dependencies": {
14
15
  "picocolors": "^1.1.0",
15
- "@assay-ai/core": "0.3.0-beta"
16
+ "@assay-ai/core": "1.3.1-beta"
16
17
  },
17
18
  "devDependencies": {
18
19
  "@types/node": "^22.0.0",