rippletide 1.0.0 → 1.0.2

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 +35 -0
  2. package/package.json +11 -3
package/README.md ADDED
@@ -0,0 +1,35 @@
1
+ # Rippletide Evaluation CLI
2
+
3
+ CLI tool to quickly run an evaluation of your Rippletide agent from the terminal.
4
+
5
+ ## Installation
6
+
7
+ ```bash
8
+ npm install -g rippletide
9
+ ```
10
+
11
+ ## Usage
12
+
13
+ Run the evaluation UI:
14
+
15
+ ```bash
16
+ rippletide
17
+ # or
18
+ rippletide eval
19
+ ```
20
+
21
+ You will be asked for:
22
+
23
+ - **Agent endpoint** (e.g. `http://localhost:8000`)
24
+ - **Knowledge source** (currently `qanda.json` in the current directory)
25
+
26
+ The CLI will:
27
+
28
+ 1. Generate an API key for the evaluation
29
+ 2. Create a temporary agent
30
+ 3. Run a small set of test prompts against your endpoint
31
+ 4. Show progress and a summary of passed/failed tests
32
+
33
+ For more details and source code, see the main repository:
34
+
35
+ - GitHub: https://github.com/rippletideco/starter
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "rippletide",
3
- "version": "1.0.0",
3
+ "version": "1.0.2",
4
4
  "description": "Rippletide Evaluation CLI",
5
5
  "main": "dist/index.js",
6
6
  "bin": {
@@ -16,8 +16,16 @@
16
16
  "cli",
17
17
  "evaluation"
18
18
  ],
19
- "author": "",
20
- "license": "ISC",
19
+ "author": "Rippletide",
20
+ "license": "MIT",
21
+ "repository": {
22
+ "type": "git",
23
+ "url": "git+https://github.com/rippletideco/starter.git"
24
+ },
25
+ "bugs": {
26
+ "url": "https://github.com/rippletideco/starter/issues"
27
+ },
28
+ "homepage": "https://github.com/rippletideco/starter#readme",
21
29
  "type": "module",
22
30
  "dependencies": {
23
31
  "axios": "^1.13.2",