dank-ai 1.0.33 → 1.0.35

package/README.md

@@ -9,7 +9,14 @@
 Dank is a powerful Node.js service that allows you to define, deploy, and manage AI agents using Docker containers. Each agent runs in its own isolated environment with configurable resources, LLM providers, and custom handlers. Built for production with comprehensive CI/CD support and Docker registry integration.
 
 🌐 **Website**: [https://dank-ai.xyz](https://dank-ai.xyz)  
-📦 **NPM Package**: [https://www.npmjs.com/package/dank-ai](https://www.npmjs.com/package/dank-ai)
+📦 **NPM Package**: [https://www.npmjs.com/package/dank-ai](https://www.npmjs.com/package/dank-ai)  
+☁️ **Cloud Deployment**: [https://cloud.dank-ai.xyz](https://cloud.dank-ai.xyz) - **Serverless for AI Agents**
+
+## ☁️ Deploy to the Cloud
+
+**Serverless for AI Agents** - Deploy your Dank agents seamlessly to the cloud with zero infrastructure management.
+
+👉 **[https://cloud.dank-ai.xyz](https://cloud.dank-ai.xyz)** - The seamless cloud deployment management serverless solution for Dank. Scale your AI agents automatically, pay only for what you use, and focus on building great agents instead of managing servers.
 
 ## ✨ Features
 
@@ -88,10 +95,7 @@ module.exports = {
         temperature: 0.7
       })
       .setPrompt('You are a helpful assistant that responds with enthusiasm!')
-      .setResources({
-        memory: '512m',
-        cpu: 1
-      })
+      .setInstanceType('small')
       .addHandler('output', (data) => {
         console.log('Assistant says:', data);
       })
@@ -212,11 +216,7 @@ const agent = createAgent('my-agent')
     authentication: false,
     maxConnections: 50
   })
-  .setResources({
-    memory: '1g',
-    cpu: 2,
-    timeout: 60000
-  });
+  .setInstanceType('medium');
 ```
 
 ### Adding HTTP Routes
@@ -526,7 +526,6 @@ agent
   prompt: "User's input prompt",
   response: "LLM's response",
   conversationId: "unique-conversation-id",
-  context: { protocol: "http" },
   usage: { total_tokens: 150, prompt_tokens: 50, completion_tokens: 100 },
   model: "gpt-3.5-turbo",
   processingTime: 1250,
@@ -581,14 +580,15 @@ createAgent('flexible-agent')
 Configure container resources:
 
 ```javascript
-.setResources({
-  memory: '512m',        // Memory limit (512m, 1g, etc.)
-  cpu: 1,                // CPU allocation (0.5, 1, 2, etc.)  
-  timeout: 30000,        // Request timeout in ms
-  maxRestarts: 3         // Max container restarts
-})
+.setInstanceType('small')  // Options: 'small', 'medium', 'large', 'xlarge'
+// small: 512m, 1 CPU
+// medium: 1g, 2 CPU
+// large: 2g, 2 CPU
+// xlarge: 4g, 4 CPU
 ```
 
+**Note:** `setInstanceType()` is only used during deployments to Dank Cloud services. When running agents locally with `dank run`, this setting is disregarded and containers run without resource limits.
+
 ### Agent Image Configuration
 
 Configure Docker image naming and registry settings for agent builds:
@@ -635,11 +635,7 @@ module.exports = {
         authentication: true,
         maxConnections: 100
       })
-      .setResources({
-        memory: '1g',
-        cpu: 2,
-        timeout: 60000
-      })
+      .setInstanceType('medium')
       // Agent image configuration
       .setAgentImageConfig({
         registry: 'ghcr.io',
@@ -664,11 +660,7 @@ module.exports = {
         authentication: false,
         maxConnections: 50
       })
-      .setResources({
-        memory: '2g',
-        cpu: 4,
-        timeout: 120000
-      })
+      .setInstanceType('large')
       // Different agent image configuration
       .setAgentImageConfig({
         registry: 'docker.io',
@@ -737,7 +729,7 @@ dank build:prod --config production.config.js --output-metadata deployment.json
 
 The `--output-metadata` option generates a JSON file containing all deployment information needed for your backend infrastructure:
 - **Base image** used (`setBaseImage()` value)
-- **Prompting server** configuration (protocol, port, authentication, maxConnections)
+- **Prompting server** configuration (port, authentication, maxConnections)
 - **Resource limits** (memory, CPU, timeout)
 - **Ports** that need to be opened
 - **Features enabled** (direct prompting, HTTP API, event handlers)
@@ -776,7 +768,6 @@ This metadata file is perfect for CI/CD pipelines to automatically configure you
       "ports": [
         {
           "port": 3000,
-          "protocol": "http",
           "description": "Direct prompting server"
         }
       ],
@@ -1194,7 +1185,7 @@ module.exports = {
         - Resolve customer issues quickly
         - Escalate complex problems appropriately
       `)
-      .setResources({ memory: '512m', cpu: 1 })
+      .setInstanceType('small')
       .addHandler('output', (data) => {
         console.log('[Customer Service]:', data);
         // Add your business logic here
@@ -1213,7 +1204,7 @@ module.exports = {
         - Provide statistical insights
         - Create actionable recommendations
       `)
-      .setResources({ memory: '1g', cpu: 2 })
+      .setInstanceType('medium')
       .addHandler('output', (data) => {
         console.log('[Analyst]:', data);
         // Save analysis results to database
@@ -1231,7 +1222,7 @@ module.exports = {
         - Adapt tone to target audience
         - Follow brand guidelines
       `)
-      .setResources({ memory: '512m', cpu: 1 })
+      .setInstanceType('small')
       .addHandler('output', (data) => {
         console.log('[Content Creator]:', data);
         // Process and publish content
@@ -1321,11 +1312,7 @@ createAgent('data-processor')
     3. Provide actionable insights
     4. Format results as JSON
   `)
-  .setResources({
-    memory: '2g',    // More memory for data processing
-    cpu: 2,          // More CPU for complex calculations
-    timeout: 120000  // Longer timeout for large datasets
-  })
+  .setInstanceType('large')  // More memory for data processing
   .addHandler('output', (analysis) => {
     try {
       const results = JSON.parse(analysis);
@@ -1408,10 +1395,7 @@ module.exports = {
         model: isDevelopment ? 'gpt-3.5-turbo' : 'gpt-4',
         temperature: isDevelopment ? 0.9 : 0.7
       })
-      .setResources({
-        memory: isDevelopment ? '256m' : '1g',
-        cpu: isDevelopment ? 0.5 : 2
-      })
+      .setInstanceType(isDevelopment ? 'small' : 'medium')
       .addHandler('output', (data) => {
         if (isDevelopment) {
           console.log('DEV:', data);
@@ -1424,63 +1408,7 @@ module.exports = {
 };
 ```
 
-### 🔧 Advanced Usage
-
-#### Environment Variables
-```bash
-export OPENAI_API_KEY="your-key"
-export ANTHROPIC_API_KEY="your-key"  
-export LOG_LEVEL="debug"
-export DOCKER_HOST="unix:///var/run/docker.sock"
-export NODE_ENV="production"
-```
-
-#### Integration with Existing Applications
-```javascript
-// In your existing Node.js application
-const { spawn } = require('child_process');
-
-// Start Dank agents programmatically
-function startAgents() {
-  const dankProcess = spawn('dank', ['run', '--detached'], {
-    stdio: 'inherit',
-    env: { ...process.env, NODE_ENV: 'production' }
-  });
-  
-  dankProcess.on('close', (code) => {
-    console.log(`Dank agents exited with code ${code}`);
-  });
-  
-  return dankProcess;
-}
-
-// Stop agents gracefully
-function stopAgents() {
-  spawn('dank', ['stop', '--all'], { stdio: 'inherit' });
-}
 
-// Check agent status
-async function getAgentStatus() {
-  return new Promise((resolve) => {
-    const statusProcess = spawn('dank', ['status', '--json'], {
-      stdio: ['pipe', 'pipe', 'pipe']
-    });
-    
-    let output = '';
-    statusProcess.stdout.on('data', (data) => {
-      output += data.toString();
-    });
-    
-    statusProcess.on('close', () => {
-      try {
-        resolve(JSON.parse(output));
-      } catch {
-        resolve(null);
-      }
-    });
-  });
-}
-```
 
 ### 🚨 Troubleshooting
 
@@ -1536,18 +1464,16 @@ echo "OPENAI_API_KEY=sk-your-actual-key-here" > .env
 ```bash
 # Error: Base image 'deltadarkly/dank-agent-base' not found
 # Solution: The base image is pulled automatically, but you can build it manually
+# ty also pulling manually when docker is running  via docker pull <image name>
 dank build --base
 ```
 
 **4. Container Resource Issues**
 ```bash
 # Error: Container exits with code 137 (out of memory)
-# Solution: Increase memory allocation
+# Solution: Increase memory allocation (On cloud service, on local agents run with given resources)
 createAgent('my-agent')
-  .setResources({
-    memory: '1g',  // Increase from 512m to 1g
-    cpu: 2
-  })
+  .setInstanceType('medium')  // Increase from 'small' to 'medium'
 ```
 
 **5. Agent Not Starting**
@@ -1568,17 +1494,10 @@ docker logs container-id
 ```javascript
 // Good: Appropriate resource allocation
 createAgent('light-agent')
-  .setResources({
-    memory: '256m',     // Light tasks
-    cpu: 0.5
-  });
+  .setInstanceType('small');  // Light tasks
 
 createAgent('heavy-agent')
-  .setResources({
-    memory: '2g',       // Heavy processing
-    cpu: 2,
-    timeout: 120000     // Longer timeout
-  });
+  .setInstanceType('large');  // Heavy processing
 ```
 
 #### 2. Error Handling
@@ -1632,8 +1551,7 @@ createAgent('environment-aware')
     model: settings.model,
     temperature: 0.7
   })
-  .setResources({
-    memory: settings.memory
+  .setInstanceType(settings.instanceType || 'small')
   });
 ```
 
@@ -1684,37 +1602,25 @@ createAgent('secure-agent')
   });
 ```
 
-### 📊 Performance Optimization
-
-#### 1. Resource Tuning
-```bash
-# Monitor resource usage
-dank status --watch
 
-# Check container stats
-docker stats $(docker ps -f name=dank- -q)
-
-# Optimize based on usage patterns
-```
-
-#### 2. Parallel Agent Management
+#### 1. Parallel Agent Management
 ```javascript
 // Good: Balanced agent distribution
 module.exports = {
   agents: [
     // CPU-intensive agents
-    createAgent('analyzer').setResources({ cpu: 2, memory: '1g' }),
+    createAgent('analyzer').setInstanceType('medium'),
     
     // Memory-intensive agents  
-    createAgent('processor').setResources({ cpu: 1, memory: '2g' }),
+    createAgent('processor').setInstanceType('large'),
     
     // Light agents
-    createAgent('notifier').setResources({ cpu: 0.5, memory: '256m' })
+    createAgent('notifier').setInstanceType('small')
   ]
 };
 ```
 
-#### 3. Efficient Prompt Design
+#### 2. Efficient Prompt Design
 ```javascript
 // Good: Clear, specific prompts
 .setPrompt(`
@@ -1743,7 +1649,7 @@ dank stop --all
 dank run --build  # Rebuild if needed
 
 # 4. Test with reduced resources
-createAgent('dev-agent').setResources({ memory: '128m', cpu: 0.25 })
+createAgent('dev-agent').setInstanceType('small')
 ```
 
 #### 2. Testing Agents
@@ -1824,10 +1730,7 @@ ISC License - see LICENSE file for details.
 
 ## 🆘 Support
 
-- **Documentation**: [Wiki](https://github.com/your-org/dank/wiki)
 - **Issues**: [GitHub Issues](https://github.com/your-org/dank/issues)
 - **Discussions**: [GitHub Discussions](https://github.com/your-org/dank/discussions)
 
----
-
-**Built with 💯 energy for the AI agent revolution!** 🚀
+---