mindsim 0.1.0 → 0.1.2

package/README.md

@@ -1,7 +1,9 @@
 <br/>
 <br/>
 <div align="center">
-    <img style="display: block; width: 250px;" src="assets/mindsim-logo.svg"/>
+  <a href="https://mindsim.com/">
+      <img style="display: block; width: 250px;" src="assets/mindsim-logo.svg"/>
+    </a>
 </div>
 <br/>
 <br/>
@@ -21,7 +23,7 @@ Pre-requisites before installation
 
 ### Install with NPM
 ```
-npm install -g @mindsim/mindsim-sdk-typescript
+npm install -g mindsim
 ```
 
 
@@ -66,7 +68,7 @@ const mindsim = MindSim(apiKey);
 The following example shows how you can use the mindsim SDK to create a mind:
 
 ```typescript
-import { MindSim } from "@mindsim/mindsim-sdk-typescript";
+import { MindSim } from "mindsim";
 import fs from "node:fs";
 import path from "node:path";
 
@@ -128,7 +130,7 @@ main();
 When MindSim has finished building your mind, you can run simulations on your mind:
 
 ```typescript
-import { MindSim } from "@mindsim/mindsim-sdk-typescript";
+import { MindSim } from "mindsim";
 
 const main = async () => {
   const mindsim = new MindSim(process.env.MINDSIM_API_KEY);
@@ -404,7 +406,6 @@ Response:
 ```
 
 
-
 ### Upload Snapshots
 A snapshot is a trained AI model built from conversation transcripts. It captures how someone thinks and communicates at a specific point in time.
 
@@ -469,6 +470,84 @@ Response:
 ```
 ---
 
+**Get Snapshot Details**
+
+Retrieve metadata about a snapshot. You can optionally include the full transcript or psychometric analysis in the response.
+
+```typescript
+const mindId = "9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d";
+const snapshotId = "a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11";
+
+const details = await mindsim.snapshots.getDetail(mindId, snapshotId, {
+  includeTranscript: true,
+  includePsychometrics: false
+});
+
+console.log(`Findings count: ${details.findingCount}`);
+```
+
+Response:
+```json
+{
+  "id": "a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11",
+  "mindId": "9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d",
+  "artifactId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
+  "status": "completed",
+  "psychometricCount": 12,
+  "keyTopicCount": 5,
+  "findingCount": 8,
+  "transcripts": [
+    { 
+      "text": "Speaker 1: Let's discuss the contract.", 
+      "startTime": "00:00:01" 
+    }
+  ]
+}
+```
+---
+
+**Link Snapshot to Digital Twin**
+
+Links a specific snapshot to the mind's active "Digital Twin". This designates which snapshot version is used during simulations.
+
+```typescript
+const result = await mindsim.snapshots.link(mindId, snapshotId);
+console.log(result.message); 
+```
+
+Response:
+```json
+{
+  "message": "Snapshot linked successfully",
+  "snapshot": {
+    "id": "123e4567-e89b-12d3-a456-426614174002",
+    "digitalTwinId": "123e4567-e89b-12d3-a456-426614174000",
+    "mindAssessmentId": "a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11",
+    "createdAt": "2024-01-01T00:00:00.000Z",
+    "updatedAt": "2024-01-01T00:00:00.000Z"
+  }
+}
+```
+---
+
+**Delete a Snapshot**
+
+Soft-deletes a snapshot record.
+
+```typescript
+const result = await mindsim.snapshots.delete(mindId, snapshotId);
+console.log(`Deleted snapshot: ${result.snapshotId}`);
+```
+
+Response:
+```json
+{
+  "message": "Snapshot deleted successfully",
+  "snapshotId": "a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11"
+}
+```
+---
+
 Snapshot Status
 
 Snapshots process asynchronously. You use the mindAssessmentId (returned from the create calls) as the snapshotId to check progress.
@@ -548,6 +627,7 @@ Response:
 }
 ```
 
+
 #### Data Requirements
 
 For the most accurate results, ensure that snapshots conform to the following guidelines.
@@ -742,7 +822,143 @@ To get the best simulation results, the following best practices are recommended
 - Business constraints
 - Historical context
 
+
+## 💻 CLI Usage
+
+The MindSim CLI allows you to manage resources directly from your terminal without writing code. This is useful for administrative tasks, testing, and quick lookups.
+
+Ensure you are authenticated via `mindsim auth` or have `MINDSIM_API_KEY` set in your environment before running these commands.
+
+### Minds
+
+Manage the digital minds (profiles).
+
+**List Minds**
+```bash
+# List all minds
+mindsim minds list
+
+# List minds filtered by tags
+mindsim minds list --tags developer,leader
+```
+
+**Create a Mind**
+```bash
+mindsim minds create -n "Bobby Tables" -e "bobby@example.com" --tags developer
+```
+
+**Get Mind Details**
+```bash
+mindsim minds get <mind-id>
+```
+
+**Search Minds**
+```bash
+mindsim minds search "bobby@example.com"
+```
+
+**Update a Mind**
+```bash
+mindsim minds update <mind-id> --name "Robert Tables" --tags senior-dev
+```
+
+**Set Tags (Replace)**
+```bash
+# Replaces all existing tags with the new list
+mindsim minds set-tags <mind-id> --tags hero,survivor
+```
+
+**Delete a Mind**
+```bash
+mindsim minds delete <mind-id>
+```
+
+### Snapshots
+
+Upload training data and check processing status.
+
+**List Snapshots**
+```bash
+mindsim snapshots list <mind-id>
+```
+
+**Create Snapshot (Upload File)**
+```bash
+# Upload a transcript or document
+mindsim snapshots create <mind-id> --file ./data/transcript.vtt --date 2023-11-01
+```
+
+**Check Status**
+```bash
+mindsim snapshots status <mind-id> <snapshot-id>
+```
+
+### Simulations
+
+Run simulations and view history.
+
+**Run Simulation**
+```bash
+# Run and wait for response
+mindsim simulations run <mind-id> --message "How would you handle a production outage?"
+
+# Run in background (returns immediately)
+mindsim simulations run <mind-id> --message "Analyze this text" --background
+```
+
+**List History**
+```bash
+mindsim simulations list --limit 10 --offset 0
+```
+
+**Get Simulation Details**
+```bash
+mindsim simulations get <simulation-id>
+```
+
+**Delete Simulation**
+```bash
+mindsim simulations delete <simulation-id>
+```
+
+### Tags
+
+Manage categorization tags used to organize minds.
+
+**List Tags**
+```bash
+mindsim tags list
+```
+
+**Update a Tag**
+```bash
+mindsim tags update <tag-id> --name "new-tag-name"
+```
+
+**Delete a Tag**
+```bash
+mindsim tags delete <tag-id>
+```
+
+### Psychometrics
+
+Retrieve personality analysis and dimensional data derived from a specific snapshot.
+
+**Get Psychometrics**
+```bash
+mindsim psychometrics get <snapshot-id>
+```
+
+**Get Topic Sentiment Analysis**
+```bash
+mindsim psychometrics topics <snapshot-id>
+```
+
+
 <br>
 <div align="center">
-    <img style="display: block; margin: auto;" src="assets/mindsim-logo.svg"/>
+    <a href="https://mindsim.com/">
+      <img style="display: block; margin: auto;" src="assets/mindsim-logo.svg"/>
+    </a>
 </div>
+