openkbs 0.0.80 → 0.0.81
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/package.json
CHANGED
|
@@ -7,6 +7,8 @@ description: OpenKBS AI agent development framework. Use when creating, modifyin
|
|
|
7
7
|
|
|
8
8
|
OpenKBS is a framework for building AI-powered applications - from simple agents to full-stack platforms.
|
|
9
9
|
|
|
10
|
+
> **Note:** In OpenKBS, "KB" (Knowledge Base) and "Agent" are used interchangeably. Every agent has a unique `kbId`.
|
|
11
|
+
|
|
10
12
|
## Two Usage Modes
|
|
11
13
|
|
|
12
14
|
### 1. Agent-Only Mode
|
|
@@ -32,7 +34,13 @@ Platform mode extends agent capabilities with:
|
|
|
32
34
|
- **Elastic Pulse**: Real-time WebSocket pub/sub
|
|
33
35
|
- **Whitelabel**: Custom domains (`example.com`) with static site (`site/` folder)
|
|
34
36
|
|
|
35
|
-
**Architecture Note**: The whitelabel
|
|
37
|
+
**Architecture Note**: The whitelabel is a special "service agent" with its own `kbId` that holds the entire cloud setup:
|
|
38
|
+
- Domain configuration (`domainParkingState`)
|
|
39
|
+
- Elastic services (Postgres, Storage, Pulse, Functions)
|
|
40
|
+
- CloudFront distributions
|
|
41
|
+
- SSL certificates
|
|
42
|
+
|
|
43
|
+
This whitelabel `kbId` is used in `settings.json` files throughout the project. User-facing agents in `agents/` folder each get their own separate `kbId` when pushed.
|
|
36
44
|
|
|
37
45
|
## Project Structure
|
|
38
46
|
|
|
@@ -127,6 +135,28 @@ openkbs site push # Deploy static site
|
|
|
127
135
|
openkbs site spa /app/index.html # Enable SPA routing
|
|
128
136
|
```
|
|
129
137
|
|
|
138
|
+
### Domain & Whitelabel
|
|
139
|
+
```bash
|
|
140
|
+
openkbs ls # List all agents - find whitelabel kbId here
|
|
141
|
+
openkbs ls <kbId> # View full agent details
|
|
142
|
+
openkbs ls <kbId> domain # Get just the domain name
|
|
143
|
+
openkbs ls <kbId> domainParkingState # Get domain setup details
|
|
144
|
+
openkbs publish example.com # Link agent to custom domain
|
|
145
|
+
openkbs unpublish example.com # Unlink agent from domain
|
|
146
|
+
```
|
|
147
|
+
|
|
148
|
+
**Quick domain lookup:**
|
|
149
|
+
```bash
|
|
150
|
+
# 1. Find the whitelabel agent (usually named "AI White Label" or similar)
|
|
151
|
+
openkbs ls
|
|
152
|
+
|
|
153
|
+
# 2. Get its domain
|
|
154
|
+
openkbs ls 1ya6foz1a7q3 domain
|
|
155
|
+
# -> jobavion.com
|
|
156
|
+
```
|
|
157
|
+
|
|
158
|
+
Available fields: `domain`, `domainParkingState`, `elasticPostgresHost`, `elasticStorageBucket`, `spaFallback`, etc.
|
|
159
|
+
|
|
130
160
|
### Image Generation Service
|
|
131
161
|
Generate images directly from CLI using OpenKBS AI services:
|
|
132
162
|
|
package/version.json
CHANGED