@riotprompt/riotprompt 0.0.11 → 0.0.13

package/guide/usage.md

@@ -0,0 +1,99 @@
+# Usage Patterns
+
+**Purpose**: Common patterns for using `riotprompt` via CLI and Library.
+
+## CLI Usage
+
+The CLI is the primary way to interact with filesystem-based prompts.
+
+### Directory Structure
+
+RiotPrompt expects a specific directory structure for a prompt "package":
+
+```
+my-prompt-project/
+├── persona.md          # OR directory persona/ containing .md files
+├── instructions.md     # OR directory instructions/ containing .md files
+└── context/            # Directory containing reference files (json, md, txt)
+    ├── data.json
+    └── background.md
+```
+
+### Commands
+
+**Create a New Prompt**:
+```bash
+# Create a prompt in the current directory
+riotprompt create my-new-prompt
+
+# Create with custom content
+riotprompt create my-new-prompt --persona "You are a data scientist." --instructions "Analyze this dataset."
+
+# Create without context directory
+riotprompt create my-new-prompt --no-context
+```
+
+**Process a Prompt**:
+```bash
+# Default text output (formatted for console/copy-paste)
+riotprompt process ./my-prompt-project
+
+# Specify a target model (affects formatting, e.g., role names)
+riotprompt process ./my-prompt-project --model gpt-4
+
+# Export to JSON (for API integration)
+riotprompt process ./my-prompt-project --format json --output prompt.json
+
+# Export to XML
+riotprompt process ./my-prompt-project --format xml --output prompt.xml
+```
+
+## Library Usage
+
+You can import `riotprompt` into your own TypeScript applications to build dynamic prompt pipelines.
+
+### Dynamic Context Injection
+
+A common pattern is to have static instructions but dynamic context (e.g., user data).
+
+```typescript
+import * as RiotPrompt from '@riotprompt/riotprompt';
+
+async function buildPromptForUser(userData: any) {
+    // 1. Load static parts from disk
+    const loader = RiotPrompt.Loader.create();
+    const [baseContext] = await loader.load(['./prompts/base-context']);
+    
+    // 2. Create dynamic sections
+    const userContext = RiotPrompt.createSection({ title: 'User Data' });
+    userContext.add(JSON.stringify(userData));
+
+    // 3. Create Instructions
+    const instructions = RiotPrompt.createSection({ title: 'Task' })
+        .add(RiotPrompt.createInstruction('Analyze this user data.'));
+
+    // 4. Assemble
+    const prompt = RiotPrompt.createPrompt({
+        instructions,
+        contexts: RiotPrompt.createSection({ title: 'Context' })
+            .add(baseContext)
+            .add(userContext) // Inject dynamic part
+    });
+
+    return prompt;
+}
+```
+
+### Custom Formatters
+
+If you need to output to a specific non-standard format, you can access the raw `Prompt` object structure.
+
+```typescript
+const prompt = ...;
+
+// Iterate over instructions
+prompt.instructions.items.forEach(item => {
+    console.log(item.text);
+});
+```
+

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@riotprompt/riotprompt",
-  "version": "0.0.11",
+  "version": "0.0.13",
   "keywords": [
     "prompt",
     "llm",
@@ -23,8 +23,11 @@
       "require": "./dist/riotprompt.cjs"
     }
   },
+  "bin": {
+    "riotprompt": "./dist/cli.cjs"
+  },
   "scripts": {
-    "build": "npm run lint && tsc --noEmit && vite build",
+    "build": "npm run lint && tsc --noEmit && vite build && vite build -c vite.config.cli.ts",
     "start": "dist/main.js",
     "dev": "vite",
     "watch": "vite build --watch",
@@ -43,7 +46,7 @@
     "docs:test": "cd docs && npm run test",
     "docs:coverage": "cd docs && npm run coverage"
   },
-  "author": "St. Just Reckoning <StJustReckoning@proton.me>",
+  "author": "Tim O'Brien <tobrien@discursive.com>",
   "license": "Apache-2.0",
   "devDependencies": {
     "@babel/core": "^7.28.0",
@@ -70,8 +73,16 @@
     "vitest": "^3.2.4"
   },
   "dependencies": {
+    "@anthropic-ai/sdk": "^0.71.2",
+    "@google/generative-ai": "^0.24.1",
+    "@theunwalked/cardigantime": "^0.0.17",
+    "commander": "^14.0.2",
+    "dotenv": "^17.2.3",
+    "fast-xml-parser": "^5.3.3",
     "glob": "^11.0.3",
+    "js-yaml": "^4.1.1",
     "marked": "^16.0.0",
+    "openai": "^6.15.0",
     "tiktoken": "^1.0.22",
     "zod": "^4.0.2"
   }

package/vite.config.cli.ts

@@ -0,0 +1,49 @@
+import { defineConfig } from 'vite';
+import path from 'path';
+import shebang from 'rollup-plugin-preserve-shebang';
+
+export default defineConfig({
+    resolve: {
+        alias: {
+            '@': path.resolve(__dirname, './src')
+        }
+    },
+    build: {
+        target: 'node18',
+        ssr: true, // Enable SSR mode for Node.js build
+        outDir: 'dist',
+        emptyOutDir: false,
+        lib: {
+            entry: './src/cli.ts',
+            formats: ['cjs'],
+            fileName: () => 'cli.cjs',
+        },
+        rollupOptions: {
+            external: [
+                'commander',
+                '@theunwalked/cardigantime',
+                'fs',
+                'fs/promises',
+                'path',
+                'crypto',
+                'zod',
+                'marked',
+                'tiktoken',
+                'glob',
+                'js-yaml',
+                'fast-xml-parser',
+                'openai',
+                '@anthropic-ai/sdk',
+                '@google/generative-ai',
+                'dotenv',
+                'dotenv/config'
+            ],
+            plugins: [
+                shebang({
+                    shebang: '#!/usr/bin/env node',
+                }),
+            ]
+        }
+    }
+});
+