aui-agent-builder 0.1.43 → 0.1.46
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 +79 -75
- package/dist/commands/add-integration.d.ts.map +1 -1
- package/dist/commands/add-integration.js +193 -138
- package/dist/commands/add-integration.js.map +1 -1
- package/dist/commands/add-tool.d.ts.map +1 -1
- package/dist/commands/add-tool.js +100 -82
- package/dist/commands/add-tool.js.map +1 -1
- package/dist/commands/import-agent.js +1 -1
- package/dist/commands/import-agent.js.map +1 -1
- package/dist/commands/index.d.ts +14 -15
- package/dist/commands/index.d.ts.map +1 -1
- package/dist/commands/index.js +1 -3
- package/dist/commands/index.js.map +1 -1
- package/dist/commands/init.js +9 -9
- package/dist/commands/init.js.map +1 -1
- package/dist/commands/push.d.ts.map +1 -1
- package/dist/commands/push.js +2 -43
- package/dist/commands/push.js.map +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.js +66 -82
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -28,7 +28,7 @@ aui import-agent
|
|
|
28
28
|
# 4. Edit the files in VSCode / Cursor (autocomplete works out of the box)
|
|
29
29
|
|
|
30
30
|
# 5. Validate your changes
|
|
31
|
-
aui
|
|
31
|
+
aui dvalidate
|
|
32
32
|
|
|
33
33
|
# 6. Push changes back to the backend
|
|
34
34
|
aui push
|
|
@@ -112,41 +112,41 @@ Environment selection is saved to `~/.aui/environment`.
|
|
|
112
112
|
|
|
113
113
|
### Core Workflow
|
|
114
114
|
|
|
115
|
-
| Command
|
|
116
|
-
|
|
117
|
-
| `aui login`
|
|
118
|
-
| `aui env [env]`
|
|
119
|
-
| `aui create-agent [dir]` | Scaffold a new blank agent project with examples
|
|
120
|
-
| `aui import-agent [id]`
|
|
121
|
-
| `aui
|
|
122
|
-
| `aui push`
|
|
123
|
-
| `aui status`
|
|
124
|
-
| `aui diff [a] [b]`
|
|
115
|
+
| Command | Description |
|
|
116
|
+
| ------------------------ | ------------------------------------------------------ |
|
|
117
|
+
| `aui login` | Authenticate and select org → account → agent |
|
|
118
|
+
| `aui env [env]` | Show or switch environment (staging/custom/production) |
|
|
119
|
+
| `aui create-agent [dir]` | Scaffold a new blank agent project with examples |
|
|
120
|
+
| `aui import-agent [id]` | Download an agent as local `.aui.json` files |
|
|
121
|
+
| `aui dvalidate [path]` | Validate `.aui.json` files for errors |
|
|
122
|
+
| `aui push` | Upload local changes to the backend |
|
|
123
|
+
| `aui status` | Show session, linked agent, and file summary |
|
|
124
|
+
| `aui diff [a] [b]` | Compare two agent configurations |
|
|
125
125
|
|
|
126
126
|
### Management
|
|
127
127
|
|
|
128
|
-
| Command
|
|
129
|
-
|
|
130
|
-
| `aui accounts`
|
|
131
|
-
| `aui agents`
|
|
132
|
-
| `aui list-agents` | Quick table view of agents in your account
|
|
128
|
+
| Command | Description |
|
|
129
|
+
| ----------------- | -------------------------------------------- |
|
|
130
|
+
| `aui accounts` | Manage accounts — list, create, switch |
|
|
131
|
+
| `aui agents` | Manage agents — list, create, switch, import |
|
|
132
|
+
| `aui list-agents` | Quick table view of agents in your account |
|
|
133
133
|
|
|
134
134
|
### Configuration
|
|
135
135
|
|
|
136
|
-
| Command
|
|
137
|
-
|
|
138
|
-
| `aui add-integration` | Add an integration (API, RAG, or MCP)
|
|
139
|
-
| `aui rag`
|
|
140
|
-
| `aui chat`
|
|
136
|
+
| Command | Description |
|
|
137
|
+
| --------------------- | --------------------------------------------------- |
|
|
138
|
+
| `aui add-integration` | Add an integration (API, RAG, or MCP) |
|
|
139
|
+
| `aui rag` | Manage RAG knowledge bases — upload, export, update |
|
|
140
|
+
| `aui chat` | Interactive conversation with an agent |
|
|
141
141
|
|
|
142
142
|
### Aliases
|
|
143
143
|
|
|
144
|
-
| Alias
|
|
145
|
-
|
|
146
|
-
| `aui import`
|
|
147
|
-
| `aui account` | `aui accounts`
|
|
148
|
-
| `aui agent`
|
|
149
|
-
| `aui ls`
|
|
144
|
+
| Alias | Equivalent |
|
|
145
|
+
| ------------- | ------------------ |
|
|
146
|
+
| `aui import` | `aui import-agent` |
|
|
147
|
+
| `aui account` | `aui accounts` |
|
|
148
|
+
| `aui agent` | `aui agents` |
|
|
149
|
+
| `aui ls` | `aui list-agents` |
|
|
150
150
|
|
|
151
151
|
## Account Management
|
|
152
152
|
|
|
@@ -157,6 +157,7 @@ aui accounts
|
|
|
157
157
|
```
|
|
158
158
|
|
|
159
159
|
Interactive menu with options to:
|
|
160
|
+
|
|
160
161
|
- **List** all accounts with status and creation date
|
|
161
162
|
- **Create** a new account (org owner permission required)
|
|
162
163
|
- **Switch** active account
|
|
@@ -178,6 +179,7 @@ aui agents
|
|
|
178
179
|
```
|
|
179
180
|
|
|
180
181
|
Interactive menu with options to:
|
|
182
|
+
|
|
181
183
|
- **List** all agents with current selection highlighted
|
|
182
184
|
- **Switch** active agent
|
|
183
185
|
- **Create** a new agent project (scaffolds local files)
|
|
@@ -220,6 +222,7 @@ aui import-agent --dir ./custom-folder
|
|
|
220
222
|
### Cross-Account and Cross-Org Import
|
|
221
223
|
|
|
222
224
|
To import agents from a different account or organization, use the `aui agents` menu and select:
|
|
225
|
+
|
|
223
226
|
- **Import from another account** — browse accounts in your current org
|
|
224
227
|
- **Import from another organization** — browse all your organizations, then accounts, then agents
|
|
225
228
|
|
|
@@ -232,6 +235,7 @@ aui create-agent my-agent
|
|
|
232
235
|
```
|
|
233
236
|
|
|
234
237
|
This creates a complete project with:
|
|
238
|
+
|
|
235
239
|
- Example parameters, entities, integrations, tools, and rules
|
|
236
240
|
- A `GUIDE.md` explaining every field and how to configure the agent
|
|
237
241
|
- Schema autocomplete for VSCode and Cursor
|
|
@@ -305,13 +309,13 @@ The first time you run `aui rag`, you'll be prompted to paste your RAG API key.
|
|
|
305
309
|
|
|
306
310
|
Running `aui rag` opens an interactive menu:
|
|
307
311
|
|
|
308
|
-
| Option
|
|
309
|
-
|
|
310
|
-
| **List knowledge bases**
|
|
311
|
-
| **Upload files to a knowledge base** | Upload local files (PDF, CSV, TXT, etc.) to a new or existing KB
|
|
312
|
-
| **Upload URLs to a knowledge base**
|
|
313
|
-
| **Export knowledge bases**
|
|
314
|
-
| **Update from file**
|
|
312
|
+
| Option | What it does |
|
|
313
|
+
| ------------------------------------ | ------------------------------------------------------------------ |
|
|
314
|
+
| **List knowledge bases** | Shows all KBs for the current agent with IDs and scope |
|
|
315
|
+
| **Upload files to a knowledge base** | Upload local files (PDF, CSV, TXT, etc.) to a new or existing KB |
|
|
316
|
+
| **Upload URLs to a knowledge base** | Scrape web pages into a new or existing KB |
|
|
317
|
+
| **Export knowledge bases** | Download all KB data to `aui.rag.json` in the current directory |
|
|
318
|
+
| **Update from file** | Push an edited `aui.rag.json` back to the server (diff-based sync) |
|
|
315
319
|
|
|
316
320
|
### Uploading Files
|
|
317
321
|
|
|
@@ -365,34 +369,34 @@ Skips the menu and goes straight to uploading. Choose between files or URLs, sel
|
|
|
365
369
|
Check your configuration files for errors before pushing:
|
|
366
370
|
|
|
367
371
|
```bash
|
|
368
|
-
aui
|
|
372
|
+
aui dvalidate
|
|
369
373
|
```
|
|
370
374
|
|
|
371
|
-
`aui
|
|
375
|
+
`aui dvalidate` performs **CLI validation**:
|
|
372
376
|
|
|
373
377
|
- JSON syntax
|
|
374
378
|
- Required fields (codes, types, objectives)
|
|
375
379
|
- Cross-references (e.g. tools referencing unknown integrations; entities referencing unknown parameters)
|
|
376
380
|
|
|
377
|
-
### Schema vs `aui
|
|
381
|
+
### Schema vs `aui dvalidate` (important)
|
|
378
382
|
|
|
379
383
|
When you import/create an agent, the CLI also writes:
|
|
380
384
|
|
|
381
|
-
- **`.aui-schema/aui.
|
|
385
|
+
- **`.aui-schema/aui.dschema.json`** (JSON Schema file)
|
|
382
386
|
- **`.vscode/settings.json`** (wires the schema for VSCode/Cursor)
|
|
383
387
|
|
|
384
388
|
This provides **editor validation + autocomplete** (red squiggles, enum dropdowns, hover docs).
|
|
385
389
|
|
|
386
|
-
That schema is **separate** from `aui
|
|
390
|
+
That schema is **separate** from `aui dvalidate`:
|
|
387
391
|
|
|
388
392
|
- **Schema**: editor-time, strict typing/shape checking for JSON files
|
|
389
|
-
- **`aui
|
|
393
|
+
- **`aui dvalidate`**: CLI-time checks + cross-reference integrity
|
|
390
394
|
|
|
391
395
|
If the backend introduces new fields (for example, the integrations schema expands in the V2 endpoints),
|
|
392
396
|
your editor schema may need updating. Re-importing an agent refreshes `.aui-schema/`.
|
|
393
397
|
|
|
394
398
|
```bash
|
|
395
|
-
aui
|
|
399
|
+
aui dvalidate --verbose # Detailed output per file
|
|
396
400
|
```
|
|
397
401
|
|
|
398
402
|
## Pushing Changes
|
|
@@ -441,14 +445,14 @@ Env var override:
|
|
|
441
445
|
|
|
442
446
|
The push command detects changes via git diff and pushes only what changed:
|
|
443
447
|
|
|
444
|
-
| Resource
|
|
445
|
-
|
|
446
|
-
| **Tools (modified)** | PATCH
|
|
447
|
-
| **Tools (new)**
|
|
448
|
-
| **General Settings** | PATCH
|
|
449
|
-
| **Parameters**
|
|
450
|
-
| **Entities**
|
|
451
|
-
| **Rules**
|
|
448
|
+
| Resource | Method | What gets sent |
|
|
449
|
+
| -------------------- | ------ | --------------------------------------------------- |
|
|
450
|
+
| **Tools (modified)** | PATCH | Only changed fields (name, objective, config, etc.) |
|
|
451
|
+
| **Tools (new)** | POST | Full tool object |
|
|
452
|
+
| **General Settings** | PATCH | Only changed fields |
|
|
453
|
+
| **Parameters** | PUT | Full parameters data (upsert) |
|
|
454
|
+
| **Entities** | PUT | Full entities data (upsert) |
|
|
455
|
+
| **Rules** | PUT | Full rules data (upsert) |
|
|
452
456
|
|
|
453
457
|
All changes are pushed **in parallel** for speed. After a successful push, the git baseline is updated so the next push only sends new changes.
|
|
454
458
|
|
|
@@ -509,14 +513,14 @@ aui chat --rest # REST only, no streaming
|
|
|
509
513
|
|
|
510
514
|
### Chat Commands
|
|
511
515
|
|
|
512
|
-
| Command
|
|
513
|
-
|
|
514
|
-
| `/exit`
|
|
515
|
-
| `/clear`
|
|
516
|
-
| `/history` | View message history
|
|
516
|
+
| Command | Action |
|
|
517
|
+
| ---------- | ------------------------- |
|
|
518
|
+
| `/exit` | End conversation |
|
|
519
|
+
| `/clear` | Clear screen |
|
|
520
|
+
| `/history` | View message history |
|
|
517
521
|
| `/suggest` | Get follow-up suggestions |
|
|
518
|
-
| `/task`
|
|
519
|
-
| `/help`
|
|
522
|
+
| `/task` | Show task ID |
|
|
523
|
+
| `/help` | Show commands |
|
|
520
524
|
|
|
521
525
|
## Configuration
|
|
522
526
|
|
|
@@ -534,29 +538,29 @@ aui chat --rest # REST only, no streaming
|
|
|
534
538
|
|
|
535
539
|
### Stored Files
|
|
536
540
|
|
|
537
|
-
| File
|
|
538
|
-
|
|
539
|
-
| `~/.aui/session.json`
|
|
540
|
-
| `~/.aui/environment`
|
|
541
|
-
| `~/.aui/kbm-key`
|
|
541
|
+
| File | Purpose |
|
|
542
|
+
| --------------------------- | ------------------------------------------------------------------ |
|
|
543
|
+
| `~/.aui/session.json` | Auth token, org, account, agent, environment |
|
|
544
|
+
| `~/.aui/environment` | Selected environment (staging/custom/production) |
|
|
545
|
+
| `~/.aui/kbm-key` | RAG API key (auto-saved on first use) |
|
|
542
546
|
| `~/.aui/agent-settings-key` | Agent Settings API key (fallback if Bearer token lacks permission) |
|
|
543
|
-
| `~/.aui/api-workflow-key`
|
|
544
|
-
| `.auirc`
|
|
545
|
-
| `aui.rag.json`
|
|
547
|
+
| `~/.aui/api-workflow-key` | API Workflow key (required for `aui add-integration`) |
|
|
548
|
+
| `.auirc` | Project config — links folder to a backend agent |
|
|
549
|
+
| `aui.rag.json` | Exported RAG knowledge base data |
|
|
546
550
|
|
|
547
551
|
### Environment Variables
|
|
548
552
|
|
|
549
|
-
| Variable
|
|
550
|
-
|
|
551
|
-
| `AUI_AUTH_TOKEN`
|
|
552
|
-
| `AUI_API_URL`
|
|
553
|
-
| `AUI_ENVIRONMENT`
|
|
554
|
-
| `AUI_ACCOUNT_ID`
|
|
555
|
-
| `AUI_ORGANIZATION_ID`
|
|
556
|
-
| `AUI_AGENT_CODE`
|
|
557
|
-
| `AUI_KBM_API_KEY`
|
|
558
|
-
| `AUI_AGENT_TOOLS_API_KEY` | Agent Settings API key (fallback auth)
|
|
559
|
-
| `AUI_API_WORKFLOW_KEY`
|
|
553
|
+
| Variable | Description |
|
|
554
|
+
| ------------------------- | ----------------------------------------------------- |
|
|
555
|
+
| `AUI_AUTH_TOKEN` | Auth token (skip login) |
|
|
556
|
+
| `AUI_API_URL` | Override API base URL |
|
|
557
|
+
| `AUI_ENVIRONMENT` | `staging`, `custom`, or `production` |
|
|
558
|
+
| `AUI_ACCOUNT_ID` | Account ID |
|
|
559
|
+
| `AUI_ORGANIZATION_ID` | Organization ID |
|
|
560
|
+
| `AUI_AGENT_CODE` | Agent code |
|
|
561
|
+
| `AUI_KBM_API_KEY` | RAG API key (overrides saved key in `~/.aui/kbm-key`) |
|
|
562
|
+
| `AUI_AGENT_TOOLS_API_KEY` | Agent Settings API key (fallback auth) |
|
|
563
|
+
| `AUI_API_WORKFLOW_KEY` | API Workflow key |
|
|
560
564
|
|
|
561
565
|
## License
|
|
562
566
|
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"add-integration.d.ts","sourceRoot":"","sources":["../../src/commands/add-integration.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;
|
|
1
|
+
{"version":3,"file":"add-integration.d.ts","sourceRoot":"","sources":["../../src/commands/add-integration.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AAwBH,MAAM,WAAW,qBAAqB;IACpC,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED;;GAEG;AACH,wBAAsB,cAAc,CAClC,QAAQ,GAAE,qBAA0B,GACnC,OAAO,CAAC,IAAI,CAAC,CAuEf"}
|