@inkeep/create-agents 0.0.0-dev-20250910232631
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/README.md +158 -0
- package/dist/index.d.ts +2 -0
- package/dist/index.js +38 -0
- package/package.json +61 -0
package/README.md
ADDED
|
@@ -0,0 +1,158 @@
|
|
|
1
|
+
# create-agents
|
|
2
|
+
|
|
3
|
+
Create an Inkeep Agent Framework directory with multi-service architecture.
|
|
4
|
+
|
|
5
|
+
## Quick Start
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
# Interactive mode
|
|
9
|
+
npx @inkeep/create-agents
|
|
10
|
+
|
|
11
|
+
# With directory name
|
|
12
|
+
npx @inkeep/create-agents my-agent-directory
|
|
13
|
+
|
|
14
|
+
# With options
|
|
15
|
+
npx @inkeep/create-agents my-agent-directory --tenant-id default --project-id my-project --openai-key sk-... --anthropic-key sk-ant-...
|
|
16
|
+
```
|
|
17
|
+
|
|
18
|
+
## Usage
|
|
19
|
+
|
|
20
|
+
`@inkeep/create-agents` is a wrapper around the Inkeep CLI's `create` command that sets up a complete Agent Framework directory with:
|
|
21
|
+
|
|
22
|
+
### Interactive Mode
|
|
23
|
+
Run without arguments for an interactive setup experience:
|
|
24
|
+
```bash
|
|
25
|
+
npx @inkeep/create-agents
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
You'll be prompted for:
|
|
29
|
+
- Directory name
|
|
30
|
+
- Tenant ID
|
|
31
|
+
- Project ID
|
|
32
|
+
- Anthropic API key (recommended)
|
|
33
|
+
- OpenAI API key (optional)
|
|
34
|
+
|
|
35
|
+
### Direct Mode
|
|
36
|
+
Specify options directly:
|
|
37
|
+
```bash
|
|
38
|
+
npx @inkeep/create-agents my-agent-directory --tenant-id my-tenant --project-id my-project-id --anthropic-key sk-ant-... --openai-key sk-...
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
## Options
|
|
42
|
+
|
|
43
|
+
- `--tenant-id <tenant-id>` - Your Inkeep tenant ID
|
|
44
|
+
- `--project-id <project-id>` - Project identifier for your agents
|
|
45
|
+
- `--openai-key <openai-key>` - OpenAI API key (optional)
|
|
46
|
+
- `--anthropic-key <anthropic-key>` - Anthropic API key (recommended)
|
|
47
|
+
- `--manage-api-port <port>` - Management API port (default: 3002)
|
|
48
|
+
- `--run-api-port <port>` - Run API port (default: 3003)
|
|
49
|
+
|
|
50
|
+
## What's Created
|
|
51
|
+
|
|
52
|
+
After running `@inkeep/create-agents`, you'll have a complete Agent Framework Directory:
|
|
53
|
+
|
|
54
|
+
```
|
|
55
|
+
my-agent-directory/
|
|
56
|
+
├── src/
|
|
57
|
+
│ └── <project-id>/ # Agent configurations
|
|
58
|
+
│ ├── hello.graph.ts # Example agent graph
|
|
59
|
+
│ ├── inkeep.config.ts # Inkeep CLI configuration
|
|
60
|
+
│ └── .env # CLI environment variables
|
|
61
|
+
├── apps/
|
|
62
|
+
│ ├── manage-api/ # Management API service
|
|
63
|
+
│ │ ├── src/index.ts # API server entry point
|
|
64
|
+
│ │ ├── package.json # Service dependencies
|
|
65
|
+
│ │ ├── tsconfig.json # TypeScript config
|
|
66
|
+
│ │ └── .env # Service environment
|
|
67
|
+
│ ├── run-api/ # Execution API service
|
|
68
|
+
│ │ ├── src/index.ts # API server entry point
|
|
69
|
+
│ │ ├── package.json # Service dependencies
|
|
70
|
+
│ │ ├── tsconfig.json # TypeScript config
|
|
71
|
+
│ │ └── .env # Service environment
|
|
72
|
+
│ └── shared/ # Shared code
|
|
73
|
+
│ └── credential-stores.ts # Credential store config
|
|
74
|
+
├── package.json # Root package with workspaces
|
|
75
|
+
├── turbo.json # Turbo build configuration
|
|
76
|
+
├── drizzle.config.ts # Database configuration
|
|
77
|
+
├── biome.json # Linting and formatting
|
|
78
|
+
├── .env # Root environment variables
|
|
79
|
+
├── .env.example # Environment template
|
|
80
|
+
├── .gitignore # Git ignore rules
|
|
81
|
+
└── README.md # Project documentation
|
|
82
|
+
```
|
|
83
|
+
|
|
84
|
+
## Next Steps
|
|
85
|
+
|
|
86
|
+
1. **Navigate to your directory:**
|
|
87
|
+
```bash
|
|
88
|
+
cd my-agent-directory
|
|
89
|
+
```
|
|
90
|
+
|
|
91
|
+
2. **Start the services:**
|
|
92
|
+
```bash
|
|
93
|
+
# Start both Management and Run APIs
|
|
94
|
+
npm run dev
|
|
95
|
+
```
|
|
96
|
+
|
|
97
|
+
3. **In a new terminal, start the Management Dashboard:**
|
|
98
|
+
```bash
|
|
99
|
+
npx inkeep dev
|
|
100
|
+
```
|
|
101
|
+
|
|
102
|
+
4. **Deploy your first agent graph:**
|
|
103
|
+
```bash
|
|
104
|
+
cd src/<project-id>/
|
|
105
|
+
npx inkeep push hello.graph.ts
|
|
106
|
+
```
|
|
107
|
+
|
|
108
|
+
5. **Test your agents:**
|
|
109
|
+
```bash
|
|
110
|
+
npx inkeep chat
|
|
111
|
+
```
|
|
112
|
+
|
|
113
|
+
## Available Services
|
|
114
|
+
|
|
115
|
+
After setup, you'll have access to:
|
|
116
|
+
|
|
117
|
+
- **Management API** (Port 3002): Agent configuration and management
|
|
118
|
+
- **Run API** (Port 3003): Agent execution and chat processing
|
|
119
|
+
- **Management Dashboard** (Port 3000): Visual agent builder (via `npx inkeep dev`)
|
|
120
|
+
|
|
121
|
+
## Commands Available in Your Directory
|
|
122
|
+
|
|
123
|
+
- `npm run dev` - Start both API services with hot reload
|
|
124
|
+
- `npm run db:push` - Apply database schema changes
|
|
125
|
+
- `npx inkeep dev` - Start the Management Dashboard
|
|
126
|
+
- `npx inkeep push <graph-file>` - Deploy agent configurations
|
|
127
|
+
- `npx inkeep chat` - Interactive chat with your agents
|
|
128
|
+
|
|
129
|
+
## Environment Variables
|
|
130
|
+
|
|
131
|
+
The directory includes multiple environment files:
|
|
132
|
+
|
|
133
|
+
### Root `.env` (shared configuration)
|
|
134
|
+
```bash
|
|
135
|
+
# AI Provider Keys
|
|
136
|
+
ANTHROPIC_API_KEY=your-anthropic-key-here
|
|
137
|
+
OPENAI_API_KEY=your-openai-key-here
|
|
138
|
+
|
|
139
|
+
# Service Ports
|
|
140
|
+
MANAGE_API_PORT=3002
|
|
141
|
+
RUN_API_PORT=3003
|
|
142
|
+
|
|
143
|
+
# Database
|
|
144
|
+
DB_FILE_NAME=file:./local.db
|
|
145
|
+
|
|
146
|
+
# Environment
|
|
147
|
+
ENVIRONMENT=development
|
|
148
|
+
LOG_LEVEL=debug
|
|
149
|
+
```
|
|
150
|
+
|
|
151
|
+
### Service-specific `.env` files
|
|
152
|
+
- `apps/manage-api/.env` - Management API configuration
|
|
153
|
+
- `apps/run-api/.env` - Run API configuration
|
|
154
|
+
- `src/<project-id>/.env` - CLI configuration
|
|
155
|
+
|
|
156
|
+
## Learn More
|
|
157
|
+
|
|
158
|
+
- 📚 [Documentation](https://docs.inkeep.com)
|
package/dist/index.d.ts
ADDED
package/dist/index.js
ADDED
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
#!/usr/bin/env node
|
|
2
|
+
import { program } from 'commander';
|
|
3
|
+
import { createAgents } from '@inkeep/agents-cli/commands/create';
|
|
4
|
+
program
|
|
5
|
+
.name('create-agents')
|
|
6
|
+
.description('Create an Inkeep Agent Framework directory')
|
|
7
|
+
.version('0.1.0')
|
|
8
|
+
.argument('[directory-name]', 'Name of the directory')
|
|
9
|
+
.option('--tenant-id <tenant-id>', 'Tenant ID')
|
|
10
|
+
.option('--project-id <project-id>', 'Project ID')
|
|
11
|
+
.option('--openai-key <openai-key>', 'OpenAI API key')
|
|
12
|
+
.option('--anthropic-key <anthropic-key>', 'Anthropic API key')
|
|
13
|
+
.option('--manage-api-port <port>', 'Management API port', '3002')
|
|
14
|
+
.option('--run-api-port <port>', 'Run API port', '3003')
|
|
15
|
+
.parse();
|
|
16
|
+
async function main() {
|
|
17
|
+
const options = program.opts();
|
|
18
|
+
const directoryName = program.args[0];
|
|
19
|
+
try {
|
|
20
|
+
await createAgents({
|
|
21
|
+
dirName: directoryName,
|
|
22
|
+
openAiKey: options.openaiKey,
|
|
23
|
+
anthropicKey: options.anthropicKey,
|
|
24
|
+
tenantId: options.tenantId,
|
|
25
|
+
projectId: options.projectId,
|
|
26
|
+
manageApiPort: options.manageApiPort,
|
|
27
|
+
runApiPort: options.runApiPort,
|
|
28
|
+
});
|
|
29
|
+
}
|
|
30
|
+
catch (error) {
|
|
31
|
+
console.error('Failed to create directory:', error);
|
|
32
|
+
process.exit(1);
|
|
33
|
+
}
|
|
34
|
+
}
|
|
35
|
+
main().catch((error) => {
|
|
36
|
+
console.error('An unexpected error occurred:', error);
|
|
37
|
+
process.exit(1);
|
|
38
|
+
});
|
package/package.json
ADDED
|
@@ -0,0 +1,61 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@inkeep/create-agents",
|
|
3
|
+
"version": "0.0.0-dev-20250910232631",
|
|
4
|
+
"description": "Create an Inkeep Agent Framework project",
|
|
5
|
+
"type": "module",
|
|
6
|
+
"bin": {
|
|
7
|
+
"create-agents": "./dist/index.js"
|
|
8
|
+
},
|
|
9
|
+
"files": [
|
|
10
|
+
"dist",
|
|
11
|
+
"README.md",
|
|
12
|
+
"LICENSE.md"
|
|
13
|
+
],
|
|
14
|
+
"scripts": {
|
|
15
|
+
"dev": "tsx src/index.ts",
|
|
16
|
+
"build": "tsc",
|
|
17
|
+
"lint": "biome check .",
|
|
18
|
+
"format": "biome format --write .",
|
|
19
|
+
"test": "vitest --run --passWithNoTests",
|
|
20
|
+
"test:watch": "vitest",
|
|
21
|
+
"typecheck": "tsc --noEmit"
|
|
22
|
+
},
|
|
23
|
+
"keywords": [
|
|
24
|
+
"inkeep",
|
|
25
|
+
"agents",
|
|
26
|
+
"ai",
|
|
27
|
+
"framework",
|
|
28
|
+
"boilerplate",
|
|
29
|
+
"typescript",
|
|
30
|
+
"project",
|
|
31
|
+
"starter",
|
|
32
|
+
"cli",
|
|
33
|
+
"create",
|
|
34
|
+
"init"
|
|
35
|
+
],
|
|
36
|
+
"author": "Inkeep <support@inkeep.com>",
|
|
37
|
+
"license": "SEE LICENSE IN LICENSE.md",
|
|
38
|
+
"dependencies": {
|
|
39
|
+
"@inkeep/agents-cli": "workspace:^",
|
|
40
|
+
"commander": "^12.0.0"
|
|
41
|
+
},
|
|
42
|
+
"devDependencies": {
|
|
43
|
+
"@biomejs/biome": "^1.8.0",
|
|
44
|
+
"@types/node": "^20.12.0",
|
|
45
|
+
"tsx": "^4.7.0",
|
|
46
|
+
"typescript": "^5.4.0",
|
|
47
|
+
"vitest": "^1.6.0"
|
|
48
|
+
},
|
|
49
|
+
"engines": {
|
|
50
|
+
"node": ">=22.0.0"
|
|
51
|
+
},
|
|
52
|
+
"repository": {
|
|
53
|
+
"type": "git",
|
|
54
|
+
"url": "https://github.com/inkeep/agents.git",
|
|
55
|
+
"directory": "packages/create-agents"
|
|
56
|
+
},
|
|
57
|
+
"publishConfig": {
|
|
58
|
+
"access": "public",
|
|
59
|
+
"registry": "https://registry.npmjs.org/"
|
|
60
|
+
}
|
|
61
|
+
}
|