cognitive-modules 0.6.1__tar.gz → 2.2.1__tar.gz

{cognitive_modules-0.6.1 → cognitive_modules-2.2.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cognitive-modules
-Version: 0.6.1
+Version: 2.2.1
 Summary: Structured LLM task runner with schema validation, confidence scoring, and subagent orchestration
 Author: ziel-io
 License: MIT
@@ -69,32 +69,6 @@ English | [中文](README_zh.md)
 
 Cognitive Modules is an AI task definition specification designed for generation tasks that require **strong constraints, verifiability, and auditability**.
 
-## What's New in v2.5
-
-| Feature | Description |
-|---------|-------------|
-| **Streaming Response** | Real-time chunk-based output for better UX |
-| **Multimodal Support** | Native image, audio, and video input/output |
-| **Backward Compatible** | v2.2 modules run without modification |
-| **Level 4 Conformance** | Extended conformance level for v2.5 features |
-
-```yaml
-# module.yaml - v2.5 example
-name: image-analyzer
-version: 2.5.0
-tier: decision
-
-# v2.5: Enable streaming
-response:
-  mode: streaming
-  chunk_type: delta
-
-# v2.5: Enable multimodal
-modalities:
-  input: [text, image]
-  output: [text]
-```
-
 ## What's New in v2.2
 
 | Feature | Description |
@@ -114,7 +88,24 @@ modalities:
 - **Subagent Orchestration** - `@call:module` supports inter-module calls
 - **Parameter Passing** - `$ARGUMENTS` runtime substitution
 - **Multi-LLM Support** - OpenAI / Anthropic / MiniMax / Ollama
-- **Public Registry** - `cogn install registry:module-name`
+- **Public Registry** - `cog install registry:module-name`
+
+## Version Selection
+
+| Version | Spec | npm | PyPI | Status |
+|---------|------|-----|------|--------|
+| **v2.2** | v2.2 | `2.2.0` | `2.2.0` | ✅ Stable (recommended) |
+| **v2.5** | v2.5 | `2.5.0-beta.x` | `2.5.0bx` | 🧪 Beta (streaming + multimodal) |
+
+```bash
+# Install stable v2.2
+npm install cognitive-modules-cli@2.2.0
+pip install cognitive-modules==2.2.0
+
+# Install beta v2.5 (streaming + multimodal)
+npm install cognitive-modules-cli@beta
+pip install cognitive-modules==2.5.0b1
+```
 
 ## Installation
 
@@ -122,30 +113,27 @@ modalities:
 
 ```bash
 # Zero-install quick start (recommended)
-npx cogn run code-reviewer --args "your code"
+npx cognitive-modules-cli@2.2.0 run code-reviewer --args "your code"
 
 # Global installation
-npm install -g cogn
-
-# Or install with full package name
-npm install -g cognitive-modules-cli
+npm install -g cognitive-modules-cli@2.2.0
 ```
 
 ### Python (pip)
 
 ```bash
-pip install cognitive-modules
+pip install cognitive-modules==2.2.0
 
 # With LLM support
-pip install cognitive-modules[openai]      # OpenAI
-pip install cognitive-modules[anthropic]   # Claude
-pip install cognitive-modules[all]         # All providers
+pip install "cognitive-modules[openai]==2.2.0"      # OpenAI
+pip install "cognitive-modules[anthropic]==2.2.0"   # Claude
+pip install "cognitive-modules[all]==2.2.0"         # All providers
 ```
 
 | Platform | Package | Command | Features |
 |----------|---------|---------|----------|
-| **npm** | `cogn` | `cog` | ✅ Recommended, zero-install, full features |
-| pip | `cognitive-modules` | `cogn` | ✅ Full features |
+| **npm** | `cognitive-modules-cli` | `cog` | ✅ Recommended, zero-install, full features |
+| pip | `cognitive-modules` | `cog` | ✅ Full features |
 
 ## Quick Start
 
@@ -155,7 +143,7 @@ export LLM_PROVIDER=openai
 export OPENAI_API_KEY=sk-xxx
 
 # Run code review (npm)
-npx cogn run code-reviewer --args "def login(u,p): return db.query(f'SELECT * FROM users WHERE name={u}')" --pretty
+npx cognitive-modules-cli run code-reviewer --args "def login(u,p): return db.query(f'SELECT * FROM users WHERE name={u}')" --pretty
 
 # Or use globally installed cog command
 cog run code-reviewer --args "..." --pretty
@@ -221,70 +209,70 @@ All modules now return the unified v2.2 envelope format:
 | **Risk Aggregation** | `meta.risk = max(changes[*].risk)` |
 | **Parameter Passing** | `$ARGUMENTS` runtime substitution |
 | **Subagents** | `@call:module` for inter-module calls |
-| **Validation Tools** | `cogn validate` / `cogn validate --v22` |
+| **Validation Tools** | `cog validate` / `cog validate --v22` |
 
 ## Integration Methods
 
 | Method | Command | Use Case |
 |--------|---------|----------|
-| CLI | `cogn run` | Command line |
-| HTTP API | `cogn serve` | n8n, Coze, Dify |
-| MCP Server | `cogn mcp` | Claude, Cursor |
+| CLI | `cog run` | Command line |
+| HTTP API | `cog serve` | n8n, Coze, Dify |
+| MCP Server | `cog mcp` | Claude, Cursor |
 
 ## CLI Commands
 
 ```bash
 # Module management
-cogn list                    # List installed modules
-cogn info <module>           # View module details
-cogn validate <module>       # Validate module structure
-cogn validate <module> --v22 # Validate v2.2 format
+cog list                    # List installed modules
+cog info <module>           # View module details
+cog validate <module>       # Validate module structure
+cog validate <module> --v22 # Validate v2.2 format
 
 # Run modules
-cogn run <module> input.json -o output.json --pretty
-cogn run <module> --args "requirements" --pretty
-cogn run <module> --args "requirements" --subagent  # Enable subagent
+cog run <module> input.json -o output.json --pretty
+cog run <module> --args "requirements" --pretty
+cog run <module> --args "requirements" --subagent  # Enable subagent
 
 # Create modules
-cogn init <name> -d "description"
-cogn init <name> --format v22  # Create v2.2 format module
+cog init <name> -d "description"
+cog init <name> --format v22  # Create v2.2 format module
 
 # Migrate modules
-cogn migrate <module>        # Migrate v1/v2.1 module to v2.2
+cog migrate <module>        # Migrate v1/v2.1 module to v2.2
 
 # Install from GitHub (recommended)
-cogn add ziel-io/cognitive-modules -m code-simplifier
-cogn add org/repo -m module-name --tag v1.0.0   # Install specific version
-cogn remove <module>                             # Remove module
+cog add ziel-io/cognitive-modules -m code-simplifier
+cog add org/repo -m module-name --tag v1.0.0   # Install specific version
+cog remove <module>                             # Remove module
 
 # Version management
-cogn update <module>                 # Update to latest version
-cogn update <module> --tag v2.0.0    # Update to specific version
-cogn versions <url>                  # View available versions
+cog update <module>                 # Update to latest version
+cog update <module> --tag v2.0.0    # Update to specific version
+cog versions <url>                  # View available versions
 
 # Other installation methods
-cogn install github:user/repo/path
-cogn install registry:module-name
-cogn uninstall <module>
+cog install github:user/repo/path
+cog install registry:module-name
+cog uninstall <module>
 
 # Registry
-cogn registry                # View public modules
-cogn search <query>          # Search modules
+cog registry                # View public modules
+cog search <query>          # Search modules
 
 # Environment check
-cogn doctor
+cog doctor
 ```
 
 ## Built-in Modules
 
 | Module | Tier | Function | Example |
 |--------|------|----------|---------|
-| `code-reviewer` | decision | Code review | `cogn run code-reviewer --args "your code"` |
-| `code-simplifier` | decision | Code simplification | `cogn run code-simplifier --args "complex code"` |
-| `task-prioritizer` | decision | Task priority sorting | `cogn run task-prioritizer --args "task1,task2"` |
-| `api-designer` | decision | REST API design | `cogn run api-designer --args "order system"` |
-| `ui-spec-generator` | exploration | UI spec generation | `cogn run ui-spec-generator --args "e-commerce homepage"` |
-| `product-analyzer` | exploration | Product analysis (subagent) | `cogn run product-analyzer --args "health product" -s` |
+| `code-reviewer` | decision | Code review | `cog run code-reviewer --args "your code"` |
+| `code-simplifier` | decision | Code simplification | `cog run code-simplifier --args "complex code"` |
+| `task-prioritizer` | decision | Task priority sorting | `cog run task-prioritizer --args "task1,task2"` |
+| `api-designer` | decision | REST API design | `cog run api-designer --args "order system"` |
+| `ui-spec-generator` | exploration | UI spec generation | `cog run ui-spec-generator --args "e-commerce homepage"` |
+| `product-analyzer` | exploration | Product analysis (subagent) | `cog run product-analyzer --args "health product" -s` |
 
 ## Module Format
 
@@ -355,83 +343,6 @@ my-module/
 | `decision` | Judgment/evaluation/classification | medium | Enabled |
 | `exploration` | Exploration/research/inspiration | low | Enabled |
 
-## v2.5 Streaming & Multimodal
-
-### Streaming Response
-
-Enable real-time streaming for better UX:
-
-```yaml
-# module.yaml
-response:
-  mode: streaming      # sync | streaming | both
-  chunk_type: delta    # delta | snapshot
-```
-
-**JavaScript/TypeScript Usage:**
-
-```typescript
-import { runModuleStream } from 'cognitive-modules-cli';
-
-// Stream execution
-for await (const chunk of runModuleStream(module, provider, { input })) {
-  if ('delta' in chunk.chunk) {
-    process.stdout.write(chunk.chunk.delta);
-  } else if ('final' in chunk) {
-    console.log('\nComplete:', chunk.data);
-  }
-}
-```
-
-**Python Usage:**
-
-```python
-from cognitive import StreamingRunner
-
-runner = StreamingRunner()
-async for chunk in runner.execute_stream("image-analyzer", input_data):
-    if chunk.get("chunk"):
-        print(chunk["chunk"]["delta"], end="")
-    elif chunk.get("final"):
-        print("\nComplete:", chunk["data"])
-```
-
-### Multimodal Input
-
-Enable image/audio/video processing:
-
-```yaml
-# module.yaml
-modalities:
-  input: [text, image, audio]
-  output: [text, image]
-```
-
-**JavaScript/TypeScript Usage:**
-
-```typescript
-const result = await runModule(module, provider, {
-  input: {
-    prompt: "Describe this image",
-    images: [
-      { type: "url", url: "https://example.com/image.jpg" },
-      { type: "base64", media_type: "image/png", data: "iVBORw0K..." }
-    ]
-  }
-});
-```
-
-**Python Usage:**
-
-```python
-result = await runner.execute("image-analyzer", {
-    "prompt": "Describe this image",
-    "images": [
-        {"type": "url", "url": "https://example.com/image.jpg"},
-        {"type": "file", "path": "./local-image.png"}
-    ]
-})
-
 ## Using with AI Tools
 
 ### Cursor / Codex CLI
@@ -473,7 +384,7 @@ export MINIMAX_API_KEY=sk-xxx
 export LLM_PROVIDER=ollama
 
 # Check configuration
-cogn doctor
+cog doctor
 ```
 
 ## Migrating to v2.2
@@ -482,13 +393,13 @@ Migrate from v1 or v2.1 modules to v2.2:
 
 ```bash
 # Auto-migrate single module
-cogn migrate code-reviewer
+cog migrate code-reviewer
 
 # Migrate all modules
-cogn migrate --all
+cog migrate --all
 
 # Verify migration result
-cogn validate code-reviewer --v22
+cog validate code-reviewer --v22
 ```
 
 Manual migration steps:
@@ -511,8 +422,8 @@ pip install -e ".[dev]"
 pytest tests/ -v
 
 # Create new module (v2.2 format)
-cogn init my-module -d "module description" --format v22
-cogn validate my-module --v22
+cog init my-module -d "module description" --format v22
+cog validate my-module --v22
 ```
 
 ## Project Structure
@@ -546,8 +457,8 @@ cognitive-modules/
 
 | Platform | Package | Command | Installation |
 |----------|---------|---------|--------------|
-| Python | `cognitive-modules` | `cogn` | `pip install cognitive-modules` |
-| Node.js | `cogn` or `cognitive-modules-cli` | `cog` | `npm install -g cogn` or `npx cogn` |
+| Python | `cognitive-modules` | `cog` | `pip install cognitive-modules` |
+| Node.js | `cognitive-modules-cli` | `cog` | `npm install -g cognitive-modules-cli` |
 
 Both versions share the same module format and v2.2 specification.
 
@@ -557,8 +468,6 @@ Both versions share the same module format and v2.2 specification.
 
 | Document | Description |
 |----------|-------------|
-| [SPEC-v2.5.md](SPEC-v2.5.md) | v2.5 full specification (Streaming, Multimodal) |
-| [SPEC-v2.5_zh.md](SPEC-v2.5_zh.md) | v2.5 规范中文版 |
 | [SPEC-v2.2.md](SPEC-v2.2.md) | v2.2 full specification (Control/Data separation, Tier, Overflow) |
 | [SPEC-v2.2_zh.md](SPEC-v2.2_zh.md) | v2.2 规范中文版 |
 | [SPEC.md](SPEC.md) | v0.1 specification (context philosophy) |