@inkeep/create-agents 0.0.0-dev-20250916190005 → 0.0.0-dev-20250917200022
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/utils.js +3 -178
- package/package.json +1 -1
package/dist/utils.js
CHANGED
|
@@ -279,15 +279,9 @@ ANTHROPIC_API_KEY=${config.anthropicKey || 'your-anthropic-key-here'}
|
|
|
279
279
|
OPENAI_API_KEY=${config.openAiKey || 'your-openai-key-here'}
|
|
280
280
|
GOOGLE_GENERATIVE_AI_API_KEY=${config.googleKey || 'your-google-key-here'}
|
|
281
281
|
|
|
282
|
-
#
|
|
283
|
-
|
|
284
|
-
|
|
285
|
-
# Service Ports
|
|
286
|
-
MANAGE_API_PORT=${config.manageApiPort}
|
|
287
|
-
RUN_API_PORT=${config.runApiPort}
|
|
288
|
-
|
|
289
|
-
# UI Configuration (for dashboard)
|
|
290
|
-
|
|
282
|
+
# SigNoz
|
|
283
|
+
NEXT_PUBLIC_SIGNOZ_URL=your-signoz-url-here
|
|
284
|
+
SIGNOZ_API_KEY=your-signoz-api-key-here
|
|
291
285
|
`;
|
|
292
286
|
await fs.writeFile('.env', envContent);
|
|
293
287
|
// Create .env.example
|
|
@@ -353,175 +347,6 @@ export const myProject = project({
|
|
|
353
347
|
await fs.writeFile(`src/${config.projectId}/index.ts`, customIndexContent);
|
|
354
348
|
}
|
|
355
349
|
}
|
|
356
|
-
async function createTurboConfig() {
|
|
357
|
-
const turboConfig = {
|
|
358
|
-
$schema: 'https://turbo.build/schema.json',
|
|
359
|
-
ui: 'tui',
|
|
360
|
-
globalDependencies: ['**/.env', '**/.env.local', '**/.env.*'],
|
|
361
|
-
globalEnv: [
|
|
362
|
-
'NODE_ENV',
|
|
363
|
-
'CI',
|
|
364
|
-
'ANTHROPIC_API_KEY',
|
|
365
|
-
'OPENAI_API_KEY',
|
|
366
|
-
'ENVIRONMENT',
|
|
367
|
-
'DB_FILE_NAME',
|
|
368
|
-
'MANAGE_API_PORT',
|
|
369
|
-
'RUN_API_PORT',
|
|
370
|
-
'LOG_LEVEL',
|
|
371
|
-
'NANGO_SECRET_KEY',
|
|
372
|
-
],
|
|
373
|
-
tasks: {
|
|
374
|
-
build: {
|
|
375
|
-
dependsOn: ['^build'],
|
|
376
|
-
inputs: ['$TURBO_DEFAULT$', '.env*'],
|
|
377
|
-
outputs: ['dist/**', 'build/**', '.next/**', '!.next/cache/**'],
|
|
378
|
-
},
|
|
379
|
-
dev: {
|
|
380
|
-
cache: false,
|
|
381
|
-
persistent: true,
|
|
382
|
-
},
|
|
383
|
-
start: {
|
|
384
|
-
dependsOn: ['build'],
|
|
385
|
-
cache: false,
|
|
386
|
-
},
|
|
387
|
-
'db:push': {
|
|
388
|
-
cache: false,
|
|
389
|
-
inputs: ['drizzle.config.ts', 'src/data/db/schema.ts'],
|
|
390
|
-
},
|
|
391
|
-
},
|
|
392
|
-
};
|
|
393
|
-
await fs.writeJson('turbo.json', turboConfig, { spaces: 2 });
|
|
394
|
-
}
|
|
395
|
-
async function createDocumentation(config) {
|
|
396
|
-
const readme = `# ${config.dirName}
|
|
397
|
-
|
|
398
|
-
An Inkeep Agent Framework project with multi-service architecture.
|
|
399
|
-
|
|
400
|
-
## Architecture
|
|
401
|
-
|
|
402
|
-
This project follows a workspace structure with the following services:
|
|
403
|
-
|
|
404
|
-
- **Agents Manage API** (Port 3002): Agent configuration and managemen
|
|
405
|
-
- Handles entity management and configuration endpoints.
|
|
406
|
-
- **Agents Run API** (Port 3003): Agent execution and chat processing
|
|
407
|
-
- Handles agent communication. You can interact with your agents either over MCP from an MCP client or through our React UI components library
|
|
408
|
-
- **Agents Manage UI** (Port 3000): Web interface available via \`inkeep dev\`
|
|
409
|
-
- The agent framework visual builder. From the builder you can create, manage and visualize all your graphs.
|
|
410
|
-
|
|
411
|
-
## Quick Start
|
|
412
|
-
1. **Install the Inkeep CLI:**
|
|
413
|
-
\`\`\`bash
|
|
414
|
-
pnpm install -g @inkeep/agents-cli
|
|
415
|
-
\`\`\`
|
|
416
|
-
|
|
417
|
-
1. **Start services:**
|
|
418
|
-
\`\`\`bash
|
|
419
|
-
# Start Agents Manage API and Agents Run API
|
|
420
|
-
pnpm dev
|
|
421
|
-
|
|
422
|
-
# Start the Dashboard
|
|
423
|
-
inkeep dev
|
|
424
|
-
\`\`\`
|
|
425
|
-
|
|
426
|
-
3. **Deploy your first agent graph:**
|
|
427
|
-
\`\`\`bash
|
|
428
|
-
# Navigate to your project's graph directory
|
|
429
|
-
cd src/${config.projectId}/
|
|
430
|
-
|
|
431
|
-
# Push the weather graph to create it
|
|
432
|
-
inkeep push weather.graph.ts
|
|
433
|
-
\`\`\`
|
|
434
|
-
- Follow the prompts to create the project and graph
|
|
435
|
-
- Click on the "View graph in UI:" link to see the graph in the management dashboard
|
|
436
|
-
|
|
437
|
-
## Project Structure
|
|
438
|
-
|
|
439
|
-
\`\`\`
|
|
440
|
-
${config.dirName}/
|
|
441
|
-
├── src/
|
|
442
|
-
│ ├── /${config.projectId} # Agent configurations
|
|
443
|
-
├── apps/
|
|
444
|
-
│ ├── manage-api/ # Agents Manage API service
|
|
445
|
-
│ ├── run-api/ # Agents Run API service
|
|
446
|
-
│ └── shared/ # Shared code between API services
|
|
447
|
-
│ └── credential-stores.ts # Shared credential store configuration
|
|
448
|
-
├── turbo.json # Turbo configuration
|
|
449
|
-
├── pnpm-workspace.yaml # pnpm workspace configuration
|
|
450
|
-
└── package.json # Root package configuration
|
|
451
|
-
\`\`\`
|
|
452
|
-
|
|
453
|
-
## Configuration
|
|
454
|
-
|
|
455
|
-
### Environment Variables
|
|
456
|
-
|
|
457
|
-
Environment variables are defined in the following places:
|
|
458
|
-
|
|
459
|
-
- \`apps/manage-api/.env\`: Agents Manage API environment variables
|
|
460
|
-
- \`apps/run-api/.env\`: Agents Run API environment variables
|
|
461
|
-
- \`src/${config.projectId}/.env\`: Inkeep CLI environment variables
|
|
462
|
-
- \`.env\`: Root environment variables
|
|
463
|
-
|
|
464
|
-
To change the API keys used by your agents modify \`apps/run-api/.env\`. You are required to define at least one LLM provider key.
|
|
465
|
-
|
|
466
|
-
\`\`\`bash
|
|
467
|
-
# AI Provider Keys
|
|
468
|
-
ANTHROPIC_API_KEY=your-anthropic-key-here
|
|
469
|
-
OPENAI_API_KEY=your-openai-key-here
|
|
470
|
-
\`\`\`
|
|
471
|
-
|
|
472
|
-
|
|
473
|
-
|
|
474
|
-
### Agent Configuration
|
|
475
|
-
|
|
476
|
-
Your graphs are defined in \`src/${config.projectId}/weather.graph.ts\`. The default setup includes:
|
|
477
|
-
|
|
478
|
-
- **Weather Graph**: A graph that can forecast the weather in a given location.
|
|
479
|
-
|
|
480
|
-
Your inkeep configuration is defined in \`src/${config.projectId}/inkeep.config.ts\`. The inkeep configuration is used to configure defaults for the inkeep CLI. The configuration includes:
|
|
481
|
-
|
|
482
|
-
- \`tenantId\`: The tenant ID
|
|
483
|
-
- \`projectId\`: The project ID
|
|
484
|
-
- \`agentsManageApiUrl\`: The Manage API URL
|
|
485
|
-
- \`agentsRunApiUrl\`: The Run API URL
|
|
486
|
-
|
|
487
|
-
|
|
488
|
-
## Development
|
|
489
|
-
|
|
490
|
-
### Updating Your Agents
|
|
491
|
-
|
|
492
|
-
1. Edit \`src/${config.projectId}/weather.graph.ts\`
|
|
493
|
-
2. Push the graph to the platform to update: \`inkeep pus weather.graph.ts\`
|
|
494
|
-
|
|
495
|
-
### API Documentation
|
|
496
|
-
|
|
497
|
-
Once services are running, view the OpenAPI documentation:
|
|
498
|
-
|
|
499
|
-
- Manage API: http://localhost:${config.manageApiPort}/docs
|
|
500
|
-
- Run API: http://localhost:${config.runApiPort}/docs
|
|
501
|
-
|
|
502
|
-
## Learn More
|
|
503
|
-
|
|
504
|
-
- [Inkeep Documentation](https://docs.inkeep.com)
|
|
505
|
-
|
|
506
|
-
## Troubleshooting
|
|
507
|
-
|
|
508
|
-
## Inkeep CLI commands
|
|
509
|
-
|
|
510
|
-
- Ensure you are runnning commands from \`cd src/${config.projectId}\`.
|
|
511
|
-
- Validate the \`inkeep.config.ts\` file has the correct api urls.
|
|
512
|
-
- Validate that the \`.env\` file in \`src/${config.projectId}\` has the correct \`DB_FILE_NAME\`.
|
|
513
|
-
|
|
514
|
-
### Services won't start
|
|
515
|
-
|
|
516
|
-
1. Ensure all dependencies are installed: \`pnpm install\`
|
|
517
|
-
2. Check that ports 3000-3003 are available
|
|
518
|
-
|
|
519
|
-
### Agents won't respond
|
|
520
|
-
|
|
521
|
-
1. Ensure that the Agents Run API is running and includes a valid Anthropic or OpenAI API key in its .env file
|
|
522
|
-
`;
|
|
523
|
-
await fs.writeFile('README.md', readme);
|
|
524
|
-
}
|
|
525
350
|
async function installDependencies() {
|
|
526
351
|
await execAsync('pnpm install');
|
|
527
352
|
}
|