@inkeep/create-agents 0.0.0-chat-to-edit-20251119071712

package/LICENSE.md

@@ -0,0 +1,56 @@
+<!--
+AUTO-GENERATED FILE - DO NOT EDIT DIRECTLY
+Source: ./LICENSE.md
+This file is automatically copied from the root LICENSE.md during build.
+Any changes should be made to the root LICENSE.md file.
+-->
+
+# Inkeep SDK – Elastic License 2.0 with Supplemental Terms
+
+NOTE: The Inkeep SDK is licensed under the Elastic License 2.0 (ELv2), subject to Supplemental Terms included in [SUPPLEMENTAL_TERMS.md](SUPPLEMENTAL_TERMS.md). In the event of conflict, the Supplemental Terms control.
+
+# Elastic License 2.0
+
+## Acceptance  
+By using the software, you agree to all of the terms and conditions below.
+
+## Copyright License
+The licensor grants you a non-exclusive, royalty-free, worldwide, non-sublicensable, non-transferable license to use, copy, distribute, make available, and prepare derivative works of the software, in each case subject to the limitations and conditions below.
+
+## Limitations
+You may not provide the software to third parties as a hosted or managed service, where the service provides users with access to any substantial set of the features or functionality of the software.
+
+You may not move, change, disable, or circumvent the license key functionality in the software, and you may not remove or obscure any functionality in the software that is protected by the license key.
+
+You may not alter, remove, or obscure any licensing, copyright, or other notices of the licensor in the software. Any use of the licensor’s trademarks is subject to applicable law.
+
+## Patents
+The licensor grants you a license, under any patent claims the licensor can license, or becomes able to license, to make, have made, use, sell, offer for sale, import and have imported the software, in each case subject to the limitations and conditions in this license. This license does not cover any patent claims that you cause to be infringed by modifications or additions to the software. If you or your company make any written claim that the software infringes or contributes to infringement of any patent, your patent license for the software granted under these terms ends immediately. If your company makes such a claim, your patent license ends immediately for work on behalf of your company.
+
+## Notices
+You must ensure that anyone who gets a copy of any part of the software from you also gets a copy of these terms.
+
+If you modify the software, you must include in any modified copies of the software prominent notices stating that you have modified the software.
+
+## No Other Rights
+These terms do not imply any licenses other than those expressly granted in these terms.
+
+## Termination
+If you use the software in violation of these terms, such use is not licensed, and your licenses will automatically terminate. If the licensor provides you with a notice of your violation, and you cease all violation of this license no later than 30 days after you receive that notice, your licenses will be reinstated retroactively. However, if you violate these terms after such reinstatement, any additional violation of these terms will cause your licenses to terminate automatically and permanently.
+
+## No Liability
+***As far as the law allows, the software comes as is, without any warranty or condition, and the licensor will not be liable to you for any damages arising out of these terms or the use or nature of the software, under any kind of legal claim.***
+
+## Definitions
+The **licensor** is the entity offering these terms, and the **software** is the software the licensor makes available under these terms, including any portion of it.
+
+**you** refers to the individual or entity agreeing to these terms.
+
+**your company** is any legal entity, sole proprietorship, or other kind of organization that you work for, plus all organizations that have control over, are under the control of, or are under common control with that organization. **control** means ownership of substantially all the assets of an entity, or the power to direct its management and policies by vote, contract, or otherwise. Control can be direct or indirect.
+
+**your licenses** are all the licenses granted to you for the software under these terms.
+
+**use** means anything you do with the software requiring one of your licenses.
+
+**trademark** means trademarks, service marks, and similar rights.
+

package/README.md

@@ -0,0 +1,149 @@
+# create-agents
+
+Create an Inkeep Agent Framework directory with multi-service architecture.
+
+## Quick Start
+
+```bash
+# Interactive mode
+npx create-agents
+
+# With directory name
+npx create-agents my-agent-directory
+
+# With options
+npx create-agents my-agent-directory  --project-id my-project --openai-key sk-... --anthropic-key sk-ant-...
+```
+
+## Usage
+
+`@inkeep/create-agents` is a wrapper around the Inkeep CLI's `create` command that sets up a complete Agent Framework directory with:
+
+### Interactive Mode
+Run without arguments for an interactive setup experience:
+```bash
+npx create-agents
+```
+
+You'll be prompted for:
+- Directory name
+- Tenant ID
+- Project ID  
+- Anthropic API key (recommended)
+- OpenAI API key (optional)
+
+### Direct Mode
+Specify options directly:
+```bash
+pnpm create-agents my-agent-directory --project-id my-project-id --anthropic-key sk-ant-... --openai-key sk-...
+```
+
+## 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)
+
+## What's Created
+
+After running `@inkeep/create-agents`, you'll have a complete Agent Framework Directory:
+
+```
+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
+   ```
+
+## 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
+
+## Environment Variables
+
+The directory includes multiple environment files:
+
+### Root `.env` (shared configuration)
+```bash
+# AI Provider Keys
+ANTHROPIC_API_KEY=your-anthropic-key-here
+OPENAI_API_KEY=your-openai-key-here
+
+# Service Ports
+MANAGE_API_PORT=3002
+RUN_API_PORT=3003
+
+# Database
+DATABASE_URL=your-pg-database-url-here
+
+# Environment
+ENVIRONMENT=development
+LOG_LEVEL=debug
+```
+
+### Service-specific `.env` files
+- `apps/manage-api/.env` - Manage API configuration
+- `apps/run-api/.env` - Run API configuration  
+- `src/<project-id>/.env` - CLI configuration
+
+## Learn More
+
+- 📚 [Documentation](https://docs.inkeep.com)

package/SUPPLEMENTAL_TERMS.md

@@ -0,0 +1,40 @@
+<!--
+AUTO-GENERATED FILE - DO NOT EDIT DIRECTLY
+Source: ./SUPPLEMENTAL_TERMS.md
+This file is automatically copied from the root SUPPLEMENTAL_TERMS.md during build.
+Any changes should be made to the root SUPPLEMENTAL_TERMS.md file.
+-->
+
+# Inkeep SDK – Elastic License 2.0 with Supplemental Terms
+
+The Inkeep [SDK] (the "Software") is licensed under the Elastic License 2.0 ("ELv2"), available at [https://www.elastic.co/licensing/elastic-license](https://www.elastic.co/licensing/elastic-license), subject to the supplemental terms below. By using the Software, you, your company, and your licensees agree to both ELv2 and these Supplemental Terms – for purposes of these Supplemental Terms, references to "you" have the same meaning as in ELv2 and include your company and contractors acting on your behalf. In the event of conflict, these Supplemental Terms control.
+
+Any copy or redistribution of the Software must include both the ELv2 license reference and these Supplemental Terms.
+
+## 1. Restrictions
+
+### 1.1
+You may not use the Software, directly or indirectly, to offer, enable, operate, or provide any Agent Builder.
+
+### 1.2
+You may not repackage, rebrand, or otherwise expose the Software's agent-creation or orchestration functionality for third-party use, including in specialized or verticalized offerings that present substantially similar functionality to the Software.
+
+### 1.3
+For clarity, the foregoing restrictions do not prohibit your use of the Software as Embedded Assistants or Professional Services, provided neither allow third parties to create, configure, train, orchestrate, deploy, or manage their own agents or agent workflows.
+
+## 2. Definitions
+
+### 2.1 Inkeep
+**"Inkeep"** means Inkeep, Inc., a Delaware corporation with principal offices at 169 Madison Ave, Ste 2544, New York, NY, 10016, the licensor (as defined in ELv2) of the Software.
+
+### 2.2 Agent Builder
+**"Agent Builder"** means any hosted or on-premise product, platform, UI or API that allows third parties (e.g., customers, developers, or community users other than your personnel) to create, configure, compose, train, orchestrate, deploy, or manage their own Agents using the Software, or that otherwise exposes a substantial set of the Agent-creation and orchestration functionality of the Software.
+
+### 2.3 Agents
+**"Agents"** means autonomous, semi-autonomous, or automated systems — including assistants, copilots, workflows, orchestrations, or other systems powered by or incorporating artificial intelligence, machine learning, large language models, or related technologies.
+
+### 2.4 Embedded Assistant
+**"Embedded Assistant"** means embedding the Software in your own products or services to power a specific assistant/copilot/agent experience for you or your end users (e.g., a support bot in your app or an internal helpdesk agent), where end users do not receive access to any substantial set of the Software's agent-creation or orchestration features.
+
+### 2.5 Professional Services
+**"Professional Services"** means using the Software to deliver a bespoke solution to a single client where only your personnel operate the Software, the client receives access solely to the resulting assistant within the client's environment and not to the agent-creation/orchestration features of the Software, and no multi-tenant or self-service builder is provided.

package/dist/__tests__/e2e/quickstart.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/__tests__/e2e/quickstart.test.js

@@ -0,0 +1,178 @@
+import path from 'node:path';
+import { execa } from 'execa';
+import { afterEach, beforeEach, describe, expect, it } from 'vitest';
+import { cleanupDir, createTempDir, linkLocalPackages, runCommand, runCreateAgentsCLI, verifyDirectoryStructure, verifyFile, waitForServerReady, } from './utils';
+const manageApiUrl = 'http://localhost:3002';
+describe('create-agents quickstart e2e', () => {
+    let testDir;
+    let projectDir;
+    const workspaceName = 'test-project';
+    const projectId = 'activities-planner';
+    beforeEach(async () => {
+        // Create a temporary directory for each test
+        testDir = await createTempDir();
+        projectDir = path.join(testDir, workspaceName);
+    });
+    afterEach(async () => {
+        await cleanupDir(testDir);
+    });
+    it('should work e2e', async () => {
+        const monorepoRoot = path.join(__dirname, '../../../../../');
+        const createAgentsPrefix = path.join(monorepoRoot, 'create-agents-template');
+        const projectTemplatesPrefix = path.join(monorepoRoot, 'agents-cookbook/template-projects');
+        // Run the CLI with all options (non-interactive mode)
+        console.log('Running CLI with options:');
+        console.log(`Working directory: ${testDir}`);
+        const result = await runCreateAgentsCLI([
+            workspaceName,
+            '--openai-key',
+            'test-openai-key',
+            '--disable-git', // Skip git init for faster tests
+            '--local-agents-prefix',
+            createAgentsPrefix,
+            '--local-templates-prefix',
+            projectTemplatesPrefix,
+        ], testDir);
+        // Verify the CLI completed successfully
+        expect(result.exitCode, `CLI failed with exit code ${result.exitCode}\nstdout: ${result.stdout}\nstderr: ${result.stderr}`).toBe(0);
+        console.log('CLI completed successfully');
+        // Verify the core directory structure
+        console.log('Verifying directory structure...');
+        await verifyDirectoryStructure(projectDir, [
+            'src',
+            'src/inkeep.config.ts',
+            `src/projects/${projectId}`,
+            'apps/manage-api',
+            'apps/run-api',
+            'apps/mcp',
+            'apps/manage-ui',
+            '.env',
+            'package.json',
+            'drizzle.config.ts',
+        ]);
+        console.log('Directory structure verified');
+        // Verify .env file has required variables
+        console.log('Verifying .env file...');
+        await verifyFile(path.join(projectDir, '.env'), [
+            /ENVIRONMENT=development/,
+            /OPENAI_API_KEY=test-openai-key/,
+            /DATABASE_URL=postgresql:\/\/appuser:password@localhost:5432\/inkeep_agents/,
+            /INKEEP_AGENTS_MANAGE_API_URL="http:\/\/localhost:3002"/,
+            /INKEEP_AGENTS_RUN_API_URL="http:\/\/localhost:3003"/,
+            /INKEEP_AGENTS_JWT_SIGNING_SECRET=\w+/, // Random secret should be generated
+        ]);
+        console.log('.env file verified');
+        // Verify inkeep.config.ts was created
+        console.log('Verifying inkeep.config.ts...');
+        await verifyFile(path.join(projectDir, 'src/inkeep.config.ts'));
+        console.log('inkeep.config.ts verified');
+        console.log('Setting up project in database');
+        await runCommand('pnpm', ['db:migrate'], projectDir);
+        console.log('Project setup in database');
+        console.log('Starting dev servers');
+        // Start dev servers in background with output monitoring
+        const devProcess = execa('pnpm', ['dev'], {
+            cwd: path.join(projectDir, 'apps/manage-api'),
+            env: {
+                ...process.env,
+                FORCE_COLOR: '0',
+                NODE_ENV: 'test',
+            },
+            cleanup: true,
+            detached: false,
+            stderr: 'pipe',
+        });
+        // Monitor output for errors and readiness signals
+        let serverOutput = '';
+        const outputHandler = (data) => {
+            const text = data.toString();
+            serverOutput += text;
+            // Log important messages in CI
+            if (process.env.CI) {
+                if (text.includes('Error') || text.includes('EADDRINUSE') || text.includes('ready')) {
+                    console.log('[Server]:', text.trim());
+                }
+            }
+        };
+        if (devProcess.stderr)
+            devProcess.stderr.on('data', outputHandler);
+        // Handle process crashes during startup
+        devProcess.catch((error) => {
+            console.error('Dev process crashed during startup:', error.message);
+            console.error('Server output:', serverOutput);
+        });
+        console.log('Waiting for servers to be ready');
+        try {
+            // Wait for servers to be ready with retries
+            await waitForServerReady(`${manageApiUrl}/health`, 120000); // Increased to 2 minutes for CI
+            console.log('Manage API is ready');
+            console.log('Pushing project');
+            const pushResult = await runCommand('pnpm', [
+                'inkeep',
+                'push',
+                '--project',
+                `src/projects/${projectId}`,
+                '--config',
+                'src/inkeep.config.ts',
+            ], projectDir, 30000);
+            expect(pushResult.exitCode, `Push failed with exit code ${pushResult.exitCode}\nstdout: ${pushResult.stdout}\nstderr: ${pushResult.stderr}`).toBe(0);
+            console.log('Testing API requests');
+            // Test API requests
+            const response = await fetch(`${manageApiUrl}/tenants/default/projects/${projectId}`);
+            const data = await response.json();
+            expect(data.data.tenantId).toBe('default');
+            expect(data.data.id).toBe(projectId);
+            // Link to local monorepo packages
+            await linkLocalPackages(projectDir, monorepoRoot);
+            const pushResultLocal = await runCommand('pnpm', [
+                'inkeep',
+                'push',
+                '--project',
+                `src/projects/${projectId}`,
+                '--config',
+                'src/inkeep.config.ts',
+            ], projectDir, 30000);
+            expect(pushResultLocal.exitCode, `Push with local packages failed with exit code ${pushResultLocal.exitCode}\nstdout: ${pushResultLocal.stdout}\nstderr: ${pushResultLocal.stderr}`).toBe(0);
+            // Test that the project works with local packages
+            const responseLocal = await fetch(`${manageApiUrl}/tenants/default/projects/${projectId}`);
+            expect(responseLocal.status).toBe(200);
+        }
+        catch (error) {
+            console.error('Test failed with error:', error);
+            // Print server output for debugging
+            if (devProcess.stdout) {
+                const stdout = await devProcess.stdout;
+                console.log('Server stdout:', stdout);
+            }
+            if (devProcess.stderr) {
+                const stderr = await devProcess.stderr;
+                console.error('Server stderr:', stderr);
+            }
+            throw error;
+        }
+        finally {
+            console.log('Killing dev process');
+            // Kill the process and wait for it to die
+            try {
+                devProcess.kill('SIGTERM');
+            }
+            catch {
+                // Might already be dead
+            }
+            // Give it 2 seconds to shut down gracefully, then force kill
+            await new Promise((resolve) => setTimeout(resolve, 2000));
+            try {
+                devProcess.kill('SIGKILL');
+            }
+            catch {
+                // Already dead or couldn't kill
+            }
+            // Wait for the process to be fully cleaned up (with timeout)
+            await Promise.race([
+                devProcess.catch(() => { }), // Wait for process to exit
+                new Promise((resolve) => setTimeout(resolve, 5000)), // Or timeout after 5s
+            ]);
+            console.log('Dev process cleanup complete');
+        }
+    }, 720000); // 12 minute timeout for full flow with network calls (CI can be slow)
+});

package/dist/__tests__/e2e/utils.d.ts

@@ -0,0 +1,41 @@
+/**
+ * Run the create-agents CLI with the given arguments
+ */
+export declare function runCreateAgentsCLI(args: string[], cwd: string, timeout?: number): Promise<{
+    stdout: string;
+    stderr: string;
+    exitCode: number | undefined;
+}>;
+/**
+ * Run a command in the created project directory
+ */
+export declare function runCommand(command: string, args: string[], cwd: string, timeout?: number): Promise<{
+    stdout: string;
+    stderr: string;
+    exitCode: number | undefined;
+}>;
+/**
+ * Create a temporary directory for testing
+ */
+export declare function createTempDir(prefix?: string): Promise<string>;
+/**
+ * Clean up a test directory with retries
+ */
+export declare function cleanupDir(dir: string): Promise<void>;
+/**
+ * Verify that a file exists and optionally check its contents
+ */
+export declare function verifyFile(filePath: string, expectedContents?: string[] | RegExp[]): Promise<void>;
+/**
+ * Verify that a directory has the expected structure
+ */
+export declare function verifyDirectoryStructure(baseDir: string, expectedPaths: string[]): Promise<void>;
+/**
+ * Link local monorepo packages to the created project
+ * This replaces published @inkeep packages with local versions for testing
+ */
+export declare function linkLocalPackages(projectDir: string, monorepoRoot: string): Promise<void>;
+/**
+ * Wait for a server to be ready by polling a health endpoint
+ */
+export declare function waitForServerReady(url: string, timeout: number): Promise<void>;