@inkeep/create-agents 0.39.1 → 0.39.3

package/README.md

@@ -1,149 +1,70 @@
-# create-agents
+## Launch your first agent
 
-Create an Inkeep Agent Framework directory with multi-service architecture.
+### Prerequisites
 
-## Quick Start
+Before getting started, ensure you have the following installed on your system:
 
-```bash
-# Interactive mode
-npx create-agents
+- [Node.js](https://nodejs.org/en/download/) version 22 or higher
+- [Docker](https://docs.docker.com/get-docker/)
+- [pnpm](https://pnpm.io/installation) version 10 or higher
 
-# With directory name
-npx create-agents my-agent-directory
+You can verify by running:
 
-# With options
-npx create-agents my-agent-directory  --project-id my-project --openai-key sk-... --anthropic-key sk-ant-...
+```bash
+node --version
+pnpm --version
+docker --version
 ```
 
-## Usage
+### Step 1: Create a new agents project
 
-`@inkeep/create-agents` is a wrapper around the Inkeep CLI's `create` command that sets up a complete Agent Framework directory with:
+Run the quickstart script on a target folder:
 
-### Interactive Mode
-Run without arguments for an interactive setup experience:
 ```bash
-npx create-agents
+npx @inkeep/create-agents my-agents
 ```
 
-You'll be prompted for:
-- Directory name
-- Tenant ID
-- Project ID  
-- Anthropic API key (recommended)
-- OpenAI API key (optional)
+Navigate to the folder
 
-### Direct Mode
-Specify options directly:
 ```bash
-pnpm create-agents my-agent-directory --project-id my-project-id --anthropic-key sk-ant-... --openai-key sk-...
+cd my-agents
 ```
 
-## Options
-
-- `--project-id <project-id>` - Project identifier for your agents
-- `--openai-key <openai-key>` - OpenAI API key (optional)
-- `--anthropic-key <anthropic-key>` - Anthropic API key (recommended)
+Open the folder using your coding editor. To open with Cursor, you can run `cursor .`
 
-## What's Created
+### Step 2: Run the setup script
 
-After running `@inkeep/create-agents`, you'll have a complete Agent Framework Directory:
+Ensure Docker Desktop (or Docker daemon) is running before running the setup script.
 
+```bash
+pnpm setup-dev
 ```
-my-agent-directory/
-├── src/
-│   └── <project-id>/           # Agent configurations
-│       ├── hello-agent.ts      # Example agent configuration
-│       ├── inkeep.config.ts    # Inkeep CLI configuration
-│       └── .env                # CLI environment variables
-├── apps/
-│   ├── manage-api/             # Manage API service
-│   │   ├── src/index.ts        # API server entry point
-│   │   ├── package.json        # Service dependencies
-│   │   ├── tsconfig.json       # TypeScript config
-│   │   └── .env                # Service environment
-│   ├── run-api/                # Run API service  
-│   │   ├── src/index.ts        # API server entry point
-│   │   ├── package.json        # Service dependencies
-│   │   ├── tsconfig.json       # TypeScript config
-│   │   └── .env                # Service environment
-│   └── shared/                 # Shared code
-│       └── credential-stores.ts # Credential store config
-├── package.json                # Root package with workspaces
-├── turbo.json                  # Turbo build configuration
-├── drizzle.config.ts           # Database configuration
-├── biome.json                  # Linting and formatting
-├── .env                        # Root environment variables
-├── .env.example                # Environment template
-├── .gitignore                  # Git ignore rules
-└── README.md                   # Project documentation
-```
-
-## Next Steps
-
-1. **Navigate to your directory:**
-   ```bash
-   cd my-agent-directory
-   ```
-
-2. **Start the services:**
-   ```bash
-   # Start both Manage API and Run API
-   pnpm dev
-   ```
-
-3. **In a new terminal, start the Manage UI:**
-   ```bash
-   inkeep dev
-   ```
 
-4. **Deploy your project:**
-   ```bash
-   cd src/<project-id>/
-   pnpm inkeep push
-   ```
+Or if you are using a cloud database, you can skip the docker database startup by running:
 
-## Available Services
-
-After setup, you'll have access to:
-
-- **Manage API** (Port 3002): Agent configuration and management
-- **Run API** (Port 3003): Agent execution and chat processing  
-- **Manage UI** (Port 3000): Visual agent builder (via `npx inkeep dev`)
-
-## Commands Available in Your Directory
-
-- `pnpm dev` - Start both API services with hot reload
-- `pnpm db:migrate` - Apply database migrations
-- `inkeep dev` - Start the Manage UI
-- `inkeep push` - Deploy project configurations
+```bash
+pnpm setup-dev --skip-docker
+```
 
-## Environment Variables
+Make sure your DATABASE_URL environment variable is configured for your cloud database.
 
-The directory includes multiple environment files:
+### Step 3: Launch the dev environment
 
-### Root `.env` (shared configuration)
 ```bash
-# AI Provider Keys
-ANTHROPIC_API_KEY=your-anthropic-key-here
-OPENAI_API_KEY=your-openai-key-here
+pnpm dev
+```
 
-# Service Ports
-MANAGE_API_PORT=3002
-RUN_API_PORT=3003
+The Visual Builder will auto-open at http://localhost:3000.
 
-# Database
-DATABASE_URL=your-pg-database-url-here
+### Step 4: Chat with your agent
 
-# Environment
-ENVIRONMENT=development
-LOG_LEVEL=debug
-```
+Navigate to the **Activities Planner** agent at http://localhost:3000 and ask about fun activities at a location of your choice:
 
-### Service-specific `.env` files
-- `apps/manage-api/.env` - Manage API configuration
-- `apps/run-api/.env` - Run API configuration  
-- `src/<project-id>/.env` - CLI configuration
+![Chat with your agent](https://docs.inkeep.com/gifs/activities-planner.gif) 
 
-## Learn More
+### Next steps
 
-- 📚 [Documentation](https://docs.inkeep.com)
+- Learn about [inkeep push / pull](https://docs.inkeep.com/get-started/push-pull) so you can go from `SDK -> Visual Builder` and `Visual Builder -> SDK`.
+- Follow our [meeting prep agent tutorial](https://docs.inkeep.com/tutorials/agents/meeting-prep-assistant) to create an agent using the Visual Builder.
+- Follow our [fact finder agent tutorial](https://docs.inkeep.com/tutorials/agents/fact-finder) to create an agent using the TypeScript SDK.
+- Install the [Inkeep MCP](https://docs.inkeep.com/get-started/inkeep-mcp) in your IDE to enable AI coding assistants to "vibe code" your Inkeep agents.

package/dist/__tests__/utils.test.js

@@ -3,12 +3,26 @@ import fs from 'fs-extra';
 import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';
 import { cloneTemplate, cloneTemplateLocal, getAvailableTemplates } from '../templates';
 import { createAgents } from '../utils';
+// Create the mock execAsync function that will be used by promisify - hoisted so it's available in mocks
+const { mockExecAsync } = vi.hoisted(() => ({
+    mockExecAsync: vi.fn().mockResolvedValue({ stdout: '', stderr: '' }),
+}));
 // Mock all dependencies
 vi.mock('fs-extra');
 vi.mock('../templates');
 vi.mock('@clack/prompts');
-vi.mock('child_process');
-vi.mock('util');
+vi.mock('node:child_process', () => ({
+    exec: vi.fn(),
+    spawn: vi.fn(() => ({
+        pid: 12345,
+        stdio: ['pipe', 'pipe', 'pipe'],
+        on: vi.fn(),
+        kill: vi.fn(),
+    })),
+}));
+vi.mock('node:util', () => ({
+    promisify: vi.fn(() => mockExecAsync),
+}));
 // Setup default mocks
 const mockSpinner = {
     start: vi.fn().mockReturnThis(),
@@ -20,6 +34,8 @@ describe('createAgents - Template and Project ID Logic', () => {
     let processChdirSpy;
     beforeEach(() => {
         vi.clearAllMocks();
+        // Reset the mockExecAsync to default behavior
+        mockExecAsync.mockResolvedValue({ stdout: '', stderr: '' });
         // Mock process methods
         processExitSpy = vi.spyOn(process, 'exit').mockImplementation((code) => {
             // Only throw for exit(0) which is expected behavior in some tests
@@ -58,18 +74,6 @@ describe('createAgents - Template and Project ID Logic', () => {
         ]);
         vi.mocked(cloneTemplate).mockResolvedValue(undefined);
         vi.mocked(cloneTemplateLocal).mockResolvedValue(undefined);
-        // Mock util.promisify to return a mock exec function
-        const mockExecAsync = vi.fn().mockResolvedValue({ stdout: '', stderr: '' });
-        const util = require('node:util');
-        util.promisify = vi.fn(() => mockExecAsync);
-        // Mock child_process.spawn
-        const childProcess = require('node:child_process');
-        childProcess.spawn = vi.fn(() => ({
-            pid: 12345,
-            stdio: ['pipe', 'pipe', 'pipe'],
-            on: vi.fn(),
-            kill: vi.fn(),
-        }));
     });
     afterEach(() => {
         processExitSpy.mockRestore();
@@ -334,4 +338,6 @@ function setupDefaultMocks() {
     vi.mocked(getAvailableTemplates).mockResolvedValue(['event-planner', 'chatbot', 'data-analysis']);
     vi.mocked(cloneTemplate).mockResolvedValue(undefined);
     vi.mocked(cloneTemplateLocal).mockResolvedValue(undefined);
+    // Reset mockExecAsync for tests that clear mocks
+    mockExecAsync.mockResolvedValue({ stdout: '', stderr: '' });
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@inkeep/create-agents",
-  "version": "0.39.1",
+  "version": "0.39.3",
   "description": "Create an Inkeep Agent Framework project",
   "type": "module",
   "bin": {
@@ -34,7 +34,7 @@
     "drizzle-kit": "^0.31.5",
     "fs-extra": "^11.0.0",
     "picocolors": "^1.0.0",
-    "@inkeep/agents-core": "0.39.1"
+    "@inkeep/agents-core": "0.39.3"
   },
   "devDependencies": {
     "@types/degit": "^2.8.6",