viatris-exam-cli 1.8.0 → 1.8.1

package/README.md

@@ -5,12 +5,19 @@
 ## 安装
 
 ```bash
-npm link
+npm install -g viatris-exam-cli
 export VIATRIS_API_KEY="replace-with-real-key"
 viatris-exam login
 unset VIATRIS_API_KEY
 ```
 
+开始任务前更新到最新版本：
+
+```bash
+npm install -g viatris-exam-cli@latest
+viatris-exam --version
+```
+
 默认连接线上环境：
 
 ```text

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "viatris-exam-cli",
-  "version": "1.8.0",
+  "version": "1.8.1",
   "description": "Agent-friendly CLI for the Viatris exam OpenAPI",
   "type": "module",
   "bin": {

package/skills/viatris-exam-cli/SKILL.md

@@ -1,24 +1,27 @@
 ---
 name: viatris-exam-cli
 description: Operate the Viatris exam OpenAPI through its agent-friendly CLI. Use for login, products, knowledge, generation tasks, exam records, scoring, exams, questions, or medical search.
-version: 1.8.0
+version: 1.8.1
 ---
 
 # Viatris Exam CLI
 
-Use the repository-local CLI for every supported API operation. Do not call the HTTP endpoints directly when the CLI covers the task.
+Use the installed CLI for every supported API operation. Do not call the HTTP endpoints directly when the CLI covers the task.
 
 ## Start
 
-1. Run commands from the repository root.
-2. Prefer the saved credential. To initialize or rotate it, set `VIATRIS_API_KEY` and run `node src/cli.js login`; never place the key in command arguments, output, or logs.
-3. Use production by default. Set `VIATRIS_API_ENV=development` only when the user requests development or testing.
-4. Run `node src/cli.js describe --compact` when capability discovery or exact machine-readable metadata is needed.
-5. Read [references/cli-reference.md](references/cli-reference.md) before constructing a write payload or handling a nonzero exit code.
+1. Read the install and update sections in [references/cli-reference.md](references/cli-reference.md).
+2. Install `viatris-exam-cli` from npm when unavailable.
+3. Update to `viatris-exam-cli@latest` at the start of a task so capability instructions match the installed CLI.
+4. Verify with `viatris-exam --version`.
+5. Prefer the saved credential. To initialize or rotate it, set `VIATRIS_API_KEY` and run `viatris-exam login`; never place the key in command arguments, output, or logs.
+6. Use production by default. Set `VIATRIS_API_ENV=development` only when the user requests development or testing.
+7. Run `viatris-exam describe --compact` when capability discovery or exact machine-readable metadata is needed.
+8. Read the relevant command section in the reference before constructing a write payload or handling a nonzero exit code.
 
 ## Execute
 
-- Invoke the CLI as `node src/cli.js ...`. Do not require `npm link`.
+- Invoke commands through the installed `viatris-exam` binary.
 - Prefer `--input <file>` for existing payloads and stdin for generated payloads.
 - Parse successful `stdout` as JSON.
 - Parse failed `stderr` as JSON and branch on both exit code and `error.type`.

package/skills/viatris-exam-cli/references/cli-reference.md

@@ -1,12 +1,30 @@
 # CLI Reference
 
+## Install
+
+Install the CLI globally so every example below can use the `viatris-exam` command directly:
+
+```bash
+npm install -g viatris-exam-cli
+viatris-exam --version
+```
+
+## Update
+
+Update before starting a task so the installed capabilities and this Skill remain aligned:
+
+```bash
+npm install -g viatris-exam-cli@latest
+viatris-exam --version
+```
+
 ## Authentication And Environment
 
 Login once:
 
 ```bash
 export VIATRIS_API_KEY="..."
-node src/cli.js login
+viatris-exam login
 unset VIATRIS_API_KEY
 ```
 
@@ -42,9 +60,9 @@ export VIATRIS_API_KEY_PREFIX=""
 ## Capability Discovery
 
 ```bash
-node src/cli.js describe --compact
-node src/cli.js --help
-node src/cli.js --version
+viatris-exam describe --compact
+viatris-exam --help
+viatris-exam --version
 ```
 
 `describe` does not require credentials. It returns commands, paths, environment metadata, authentication metadata, and exit codes as JSON.
@@ -54,7 +72,7 @@ node src/cli.js --version
 List product master data:
 
 ```bash
-node src/cli.js products list --compact
+viatris-exam products list --compact
 ```
 
 The response is `{ "items": [...] }`, ordered by `sortOrder` and then name. Each record includes the stable `code`, Chinese name, optional English name, generic name, indication, dosage form, `active` or `inactive` status, remark, and timestamps.
@@ -62,7 +80,7 @@ The response is `{ "items": [...] }`, ordered by `sortOrder` and then name. Each
 Create a product and initialize its canonical knowledge-tree root:
 
 ```bash
-node src/cli.js products create --json '{
+viatris-exam products create --json '{
   "name": "络活喜",
   "genericName": "苯磺酸氨氯地平片",
   "indication": "高血压、冠心病",
@@ -77,7 +95,7 @@ Only `name` is required and the Chinese name must be unique. `code` is optional;
 Get a product and its fixed L1 dimensions:
 
 ```bash
-node src/cli.js products get "$PRODUCT_ID" --compact
+viatris-exam products get "$PRODUCT_ID" --compact
 ```
 
 Use the product master `id`; historical knowledge-tree root IDs remain accepted for compatibility. The response also contains nullable `nameEn`, `genericName`, `indication`, `dosageForm`, and `remark`. Product master data is outside business levels L1-L4. Use each returned `fixedDimensions[].clientRef` as the parent reference for an L2 node. Each fixed dimension also returns `level: 1` and a display `codePrefix`.
@@ -85,7 +103,7 @@ Use the product master `id`; historical knowledge-tree root IDs remain accepted
 Update verified optional medical master data:
 
 ```bash
-node src/cli.js products update "$PRODUCT_ID" --json '{
+viatris-exam products update "$PRODUCT_ID" --json '{
   "nameEn": "Lipitor",
   "genericName": "阿托伐他汀钙片",
   "indication": "高胆固醇血症、混合型血脂异常及心血管疾病预防",
@@ -99,7 +117,7 @@ Only supplied fields are updated. Each supplied value must be a nonempty string
 Replace a product knowledge tree:
 
 ```bash
-node src/cli.js products update-knowledge-tree "$PRODUCT_ID" \
+viatris-exam products update-knowledge-tree "$PRODUCT_ID" \
   --input knowledge-tree.json \
   --compact
 ```
@@ -148,7 +166,7 @@ Submit the complete L2/L3/L4 node set, between 15 and 500 nodes. Every `clientRe
 Delete all dynamic knowledge-tree content:
 
 ```bash
-node src/cli.js products delete-knowledge-tree "$PRODUCT_ID"
+viatris-exam products delete-knowledge-tree "$PRODUCT_ID"
 ```
 
 This destructive operation preserves the product root and five fixed L1 dimensions, deletes all L2-L4 nodes and evidence documents, and unbinds affected questions. Inspect the product and tree first, and execute only when the user explicitly requests the full reset.
@@ -158,7 +176,7 @@ This destructive operation preserves the product root and five fixed L1 dimensio
 Get the complete physical tree and all product documents:
 
 ```bash
-node src/cli.js knowledge tree lipitor --compact
+viatris-exam knowledge tree lipitor --compact
 ```
 
 The incremental `/knowledge` responses expose physical storage levels where the product root is 1 and fixed dimensions are 2. This differs from the product-generation business taxonomy, where the product is hidden, fixed dimensions are L1, and generated content is L2-L4.
@@ -166,7 +184,7 @@ The incremental `/knowledge` responses expose physical storage levels where the
 Create or reuse a visible path:
 
 ```bash
-node src/cli.js knowledge nodes by-path --json \
+viatris-exam knowledge nodes by-path --json \
   '{"product":"lipitor","path":["疾病知识","血脂异常基础","ASCVD 风险评估"]}'
 ```
 
@@ -175,20 +193,20 @@ The path has one to three entries. The first entry must be a fixed dimension nam
 Create or reuse one node under a known parent:
 
 ```bash
-node src/cli.js knowledge nodes create --json \
+viatris-exam knowledge nodes create --json \
   '{"parentId":"PARENT_ID","name":"ASCVD 风险评估","sortOrder":20}'
 ```
 
 Read, update, move, or delete a node:
 
 ```bash
-node src/cli.js knowledge nodes get "$NODE_ID"
-node src/cli.js knowledge nodes update "$NODE_ID" \
+viatris-exam knowledge nodes get "$NODE_ID"
+viatris-exam knowledge nodes update "$NODE_ID" \
   --json '{"name":"血脂异常与他汀治疗","sortOrder":5}'
-node src/cli.js knowledge nodes move "$NODE_ID" \
+viatris-exam knowledge nodes move "$NODE_ID" \
   --json '{"newParentId":"NEW_PARENT_ID","sortOrder":30}'
-node src/cli.js knowledge nodes delete "$NODE_ID"
-node src/cli.js knowledge nodes delete "$NODE_ID" --recursive
+viatris-exam knowledge nodes delete "$NODE_ID"
+viatris-exam knowledge nodes delete "$NODE_ID" --recursive
 ```
 
 Product roots and fixed dimensions are protected from rename, move, and deletion. Moving cannot cross products, target the node itself or its descendants, or produce levels deeper than L4. Plain deletion is the safe default and returns HTTP 409 when children or question bindings exist. `--recursive` deletes the full subtree and documents and unbinds affected questions. Inspect the node first and use recursive deletion only when explicitly requested.
@@ -196,14 +214,14 @@ Product roots and fixed dimensions are protected from rename, move, and deletion
 Manage documents:
 
 ```bash
-node src/cli.js knowledge documents list "$NODE_ID"
-node src/cli.js knowledge documents create "$NODE_ID" \
+viatris-exam knowledge documents list "$NODE_ID"
+viatris-exam knowledge documents create "$NODE_ID" \
   --json '{"title":"说明书","summary":"摘录"}'
-node src/cli.js knowledge documents upsert "$NODE_ID" \
+viatris-exam knowledge documents upsert "$NODE_ID" \
   --json '{"items":[{"title":"说明书","summary":"更新后的摘录"}]}'
-node src/cli.js knowledge documents update "$DOCUMENT_ID" \
+viatris-exam knowledge documents update "$DOCUMENT_ID" \
   --json '{"summary":"更新后的摘要"}'
-node src/cli.js knowledge documents delete "$DOCUMENT_ID"
+viatris-exam knowledge documents delete "$DOCUMENT_ID"
 ```
 
 Create reuses a document with the same title under the node. Batch upsert accepts 1-20 items and updates `summary` for existing titles. A single-document update changes only supplied fields; send `summary: null` to clear the summary. Current write contracts accept only `title` and `summary`; if input contains `url`, the CLI drops it before sending. Read responses may still contain historical URL data. Inspect a document before an explicitly requested delete.
@@ -223,7 +241,7 @@ Whitespace is normalized after removal, and leading or trailing title separators
 List generation tasks:
 
 ```bash
-node src/cli.js gen-tasks list \
+viatris-exam gen-tasks list \
   --status generating \
   --limit 20 \
   --compact
@@ -234,7 +252,7 @@ node src/cli.js gen-tasks list \
 Get one generation task:
 
 ```bash
-node src/cli.js gen-tasks get "$TASK_ID" --compact
+viatris-exam gen-tasks get "$TASK_ID" --compact
 ```
 
 For a leaf-node task, `knowledgeContext` is the mandatory target context. For a product-wide task, `dimension` is `all`, `knowledgeContext` is null, and `knowledgeContexts` contains every leaf context. Generate `questionsPerNode` questions for every listed context and follow all returned `rules`.
@@ -244,7 +262,7 @@ Each rule has `scope` and `products`. For `scope: "product"`, `products` contain
 Submit generated questions:
 
 ```bash
-node src/cli.js gen-tasks submit "$TASK_ID" --input payload.json --compact
+viatris-exam gen-tasks submit "$TASK_ID" --input payload.json --compact
 ```
 
 Payload shape:
@@ -315,13 +333,13 @@ Omit `knowledgeNodeId` for ordinary tasks. For a product-wide task it is require
 Get a submitted exam record and its frozen answers:
 
 ```bash
-node src/cli.js exam-records get "$RECORD_ID" --compact
+viatris-exam exam-records get "$RECORD_ID" --compact
 ```
 
 Get the complete scoring rules bound to the record:
 
 ```bash
-node src/cli.js exam-records scoring-rules "$RECORD_ID" --compact
+viatris-exam exam-records scoring-rules "$RECORD_ID" --compact
 ```
 
 The response includes the scoring `taskId`, `schemaVersion`, frozen question versions, evidence, V2 deduction rules, score caps, and item IDs. Use its `taskId` for scoring submission.
@@ -329,13 +347,13 @@ The response includes the scoring `taskId`, `schemaVersion`, frozen question ver
 Get a scoring task:
 
 ```bash
-node src/cli.js scoring get "$TASK_ID" --compact
+viatris-exam scoring get "$TASK_ID" --compact
 ```
 
 Submit scoring results:
 
 ```bash
-node src/cli.js scoring submit "$TASK_ID" --input results.json --compact
+viatris-exam scoring submit "$TASK_ID" --input results.json --compact
 ```
 
 Payload shape:
@@ -367,7 +385,7 @@ For V2, submit exactly one `pointJudgement` per scoring point. IDs must match th
 Create an exam:
 
 ```bash
-node src/cli.js exams create --input exam.json --compact
+viatris-exam exams create --input exam.json --compact
 ```
 
 Required top-level fields are `name`, `product`, `questionCount`, `startAt`, `endAt`, `resultPolicy`, and `assigneeIds`. `questionCount` is 1 through 150. Use either `questions` or legacy `questionIds`, never both. Each question score must be a positive integer and the complete exam must total exactly 100.
@@ -375,7 +393,7 @@ Required top-level fields are `name`, `product`, `questionCount`, `startAt`, `en
 Create questions directly:
 
 ```bash
-node src/cli.js questions create --input questions.json --compact
+viatris-exam questions create --input questions.json --compact
 ```
 
 Payload shape is `{ "items": [...] }`. Each item requires `product`, `dimension`, and `content`; provide `externalRef` for idempotency. Prefer `scoringRuleVersion: 2`, stable IDs on scoring points and deduction rules, and explicit `scoreCapRules`.
@@ -385,7 +403,7 @@ The API has partial-success semantics: inspect `accepted`, `duplicates`, and eve
 Add a question version:
 
 ```bash
-node src/cli.js questions version "$QUESTION_ID" --input version.json --compact
+viatris-exam questions version "$QUESTION_ID" --input version.json --compact
 ```
 
 Required fields are `stem`, `referenceAnswer`, nonempty `scoringPoints`, `evidence`, and `editReason`. V2 versions may also include `scoringRuleVersion: 2`, deduction rules, and `scoreCapRules`.
@@ -393,7 +411,7 @@ Required fields are `stem`, `referenceAnswer`, nonempty `scoringPoints`, `eviden
 Search medical evidence:
 
 ```bash
-node src/cli.js medical-search search "阿托伐他汀 适应症" \
+viatris-exam medical-search search "阿托伐他汀 适应症" \
   --file-type drug \
   --limit 20 \
   --max-length 1200 \
@@ -404,7 +422,7 @@ Or use JSON:
 
 ```bash
 printf '%s' '{"query":"阿托伐他汀 适应症","limit":20}' |
-  node src/cli.js medical-search search --compact
+  viatris-exam medical-search search --compact
 ```
 
 Do not combine query flags with JSON input. `limit` accepts 1-20 and defaults to 20 when omitted. `maxLength` defaults to 1200.
@@ -416,10 +434,10 @@ The response `rawJson` is already a structured object. Read `rawJson.documents`
 Choose exactly one input form:
 
 ```bash
-node src/cli.js questions create --input payload.json
-node src/cli.js questions create --input - < payload.json
-node src/cli.js questions create --json '{"items":[]}'
-printf '%s' '{"items":[]}' | node src/cli.js questions create
+viatris-exam questions create --input payload.json
+viatris-exam questions create --input - < payload.json
+viatris-exam questions create --json '{"items":[]}'
+printf '%s' '{"items":[]}' | viatris-exam questions create
 ```
 
 The top-level JSON value must be an object.

package/src/metadata.js

@@ -1,7 +1,7 @@
 import { CREDENTIAL_FILE_DISPLAY } from "./credentials.js";
 import { DOCUMENT_SANITIZATION_POLICY } from "./sanitizers/documents.js";
 
-export const VERSION = "1.8.0";
+export const VERSION = "1.8.1";
 export const DEFAULT_TIMEOUT_MS = 30_000;
 export const DEFAULT_RETRIES = 2;