@inkeep/create-agents 0.1.6 → 0.1.8

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.
Files changed (3) hide show
  1. package/README.md +22 -22
  2. package/dist/index.js +0 -0
  3. package/package.json +14 -14
package/README.md CHANGED
@@ -6,13 +6,13 @@ Create an Inkeep Agent Framework directory with multi-service architecture.
6
6
 
7
7
  ```bash
8
8
  # Interactive mode
9
- npx @inkeep/create-agents
9
+ pnpm create-agents
10
10
 
11
11
  # With directory name
12
- npx @inkeep/create-agents my-agent-directory
12
+ pnpm create-agents my-agent-directory
13
13
 
14
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-...
15
+ npx create-agents my-agent-directory --tenant-id default --project-id my-project --openai-key sk-... --anthropic-key sk-ant-...
16
16
  ```
17
17
 
18
18
  ## Usage
@@ -22,7 +22,7 @@ npx @inkeep/create-agents my-agent-directory --tenant-id default --project-id my
22
22
  ### Interactive Mode
23
23
  Run without arguments for an interactive setup experience:
24
24
  ```bash
25
- npx @inkeep/create-agents
25
+ pnpm create-agents
26
26
  ```
27
27
 
28
28
  You'll be prompted for:
@@ -35,7 +35,7 @@ You'll be prompted for:
35
35
  ### Direct Mode
36
36
  Specify options directly:
37
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-...
38
+ pnpm create-agents my-agent-directory --tenant-id my-tenant --project-id my-project-id --anthropic-key sk-ant-... --openai-key sk-...
39
39
  ```
40
40
 
41
41
  ## Options
@@ -44,7 +44,7 @@ npx @inkeep/create-agents my-agent-directory --tenant-id my-tenant --project-id
44
44
  - `--project-id <project-id>` - Project identifier for your agents
45
45
  - `--openai-key <openai-key>` - OpenAI API key (optional)
46
46
  - `--anthropic-key <anthropic-key>` - Anthropic API key (recommended)
47
- - `--manage-api-port <port>` - Management API port (default: 3002)
47
+ - `--manage-api-port <port>` - Manage API port (default: 3002)
48
48
  - `--run-api-port <port>` - Run API port (default: 3003)
49
49
 
50
50
  ## What's Created
@@ -59,12 +59,12 @@ my-agent-directory/
59
59
  │ ├── inkeep.config.ts # Inkeep CLI configuration
60
60
  │ └── .env # CLI environment variables
61
61
  ├── apps/
62
- │ ├── manage-api/ # Management API service
62
+ │ ├── manage-api/ # Manage API service
63
63
  │ │ ├── src/index.ts # API server entry point
64
64
  │ │ ├── package.json # Service dependencies
65
65
  │ │ ├── tsconfig.json # TypeScript config
66
66
  │ │ └── .env # Service environment
67
- │ ├── run-api/ # Execution API service
67
+ │ ├── run-api/ # Run API service
68
68
  │ │ ├── src/index.ts # API server entry point
69
69
  │ │ ├── package.json # Service dependencies
70
70
  │ │ ├── tsconfig.json # TypeScript config
@@ -90,41 +90,41 @@ my-agent-directory/
90
90
 
91
91
  2. **Start the services:**
92
92
  ```bash
93
- # Start both Management and Run APIs
94
- npm run dev
93
+ # Start both Manage API and Run API
94
+ pnpm dev
95
95
  ```
96
96
 
97
- 3. **In a new terminal, start the Management Dashboard:**
97
+ 3. **In a new terminal, start the Manage UI:**
98
98
  ```bash
99
- npx inkeep dev
99
+ inkeep dev
100
100
  ```
101
101
 
102
102
  4. **Deploy your first agent graph:**
103
103
  ```bash
104
104
  cd src/<project-id>/
105
- npx inkeep push hello.graph.ts
105
+ pnpm inkeep push hello.graph.ts
106
106
  ```
107
107
 
108
108
  5. **Test your agents:**
109
109
  ```bash
110
- npx inkeep chat
110
+ pnpm inkeep chat
111
111
  ```
112
112
 
113
113
  ## Available Services
114
114
 
115
115
  After setup, you'll have access to:
116
116
 
117
- - **Management API** (Port 3002): Agent configuration and management
117
+ - **Manage API** (Port 3002): Agent configuration and management
118
118
  - **Run API** (Port 3003): Agent execution and chat processing
119
- - **Management Dashboard** (Port 3000): Visual agent builder (via `npx inkeep dev`)
119
+ - **Manage UI** (Port 3000): Visual agent builder (via `npx inkeep dev`)
120
120
 
121
121
  ## Commands Available in Your Directory
122
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
123
+ - `pnpm dev` - Start both API services with hot reload
124
+ - `pnpm db:push` - Apply database schema changes
125
+ - `inkeep dev` - Start the Manage UI
126
+ - `inkeep push <graph-file>` - Deploy agent configurations
127
+ - `inkeep chat` - Interactive chat with your agents
128
128
 
129
129
  ## Environment Variables
130
130
 
@@ -149,7 +149,7 @@ LOG_LEVEL=debug
149
149
  ```
150
150
 
151
151
  ### Service-specific `.env` files
152
- - `apps/manage-api/.env` - Management API configuration
152
+ - `apps/manage-api/.env` - Manage API configuration
153
153
  - `apps/run-api/.env` - Run API configuration
154
154
  - `src/<project-id>/.env` - CLI configuration
155
155
 
package/dist/index.js CHANGED
File without changes
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@inkeep/create-agents",
3
- "version": "0.1.6",
3
+ "version": "0.1.8",
4
4
  "description": "Create an Inkeep Agent Framework project",
5
5
  "type": "module",
6
6
  "bin": {
@@ -12,16 +12,6 @@
12
12
  "LICENSE.md",
13
13
  "SUPPLEMENTAL_TERMS.md"
14
14
  ],
15
- "scripts": {
16
- "dev": "tsx src/index.ts",
17
- "build": "tsc",
18
- "lint": "biome lint .",
19
- "lint:fix": "biome check --write .",
20
- "format": "biome format --write .",
21
- "test": "vitest --run --passWithNoTests",
22
- "test:watch": "vitest",
23
- "typecheck": "tsc --noEmit"
24
- },
25
15
  "keywords": [
26
16
  "inkeep",
27
17
  "agents",
@@ -38,8 +28,8 @@
38
28
  "author": "Inkeep <support@inkeep.com>",
39
29
  "license": "SEE LICENSE IN LICENSE.md",
40
30
  "dependencies": {
41
- "@inkeep/agents-cli": "workspace:^",
42
- "commander": "^12.0.0"
31
+ "commander": "^12.0.0",
32
+ "@inkeep/agents-cli": "^0.1.8"
43
33
  },
44
34
  "devDependencies": {
45
35
  "@types/node": "^20.12.0",
@@ -58,5 +48,15 @@
58
48
  "publishConfig": {
59
49
  "access": "public",
60
50
  "registry": "https://registry.npmjs.org/"
51
+ },
52
+ "scripts": {
53
+ "dev": "tsx src/index.ts",
54
+ "build": "tsc",
55
+ "lint": "biome lint src",
56
+ "lint:fix": "biome check --write .",
57
+ "format": "biome format --write .",
58
+ "test": "vitest --run --passWithNoTests",
59
+ "test:watch": "vitest",
60
+ "typecheck": "tsc --noEmit"
61
61
  }
62
- }
62
+ }