continum 0.0.2 → 0.0.4
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 +94 -7
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,16 +1,24 @@
|
|
|
1
|
-
#
|
|
1
|
+
# continum
|
|
2
2
|
|
|
3
3
|
Interactive CLI to set up Continum SDK in your project with zero configuration.
|
|
4
4
|
|
|
5
5
|
## Usage
|
|
6
6
|
|
|
7
|
-
Run this command in your project directory:
|
|
7
|
+
Run this command in your project directory (or an empty folder):
|
|
8
8
|
|
|
9
9
|
```bash
|
|
10
|
-
npx
|
|
10
|
+
npx continum init
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
No installation required! The CLI will
|
|
13
|
+
No installation required! The CLI will:
|
|
14
|
+
- **Detect existing framework** - Automatically recognizes Next.js, Nuxt, SvelteKit, Astro, Fastify, NestJS, Hono, Express, and more
|
|
15
|
+
- **Set up a framework** (optional, if none detected) - Choose from Next.js, Nuxt, SvelteKit, Astro, Fastify, NestJS, Hono, or Express
|
|
16
|
+
- **Initialize your project** - Creates package.json if needed
|
|
17
|
+
- **Guide you through configuration** - Product type, providers, compliance frameworks
|
|
18
|
+
- **Install the SDK automatically** - Adds @continum/sdk to your project
|
|
19
|
+
- **Generate config files** - Creates continum.config.ts and examples
|
|
20
|
+
|
|
21
|
+
The CLI will guide you through:
|
|
14
22
|
|
|
15
23
|
1. **Product Type** - What kind of AI product you're building
|
|
16
24
|
2. **LLM Providers** - Which providers you're using (OpenAI, Anthropic, etc.)
|
|
@@ -28,11 +36,46 @@ After running `npx create-continum`, you'll have:
|
|
|
28
36
|
|
|
29
37
|
## Example Session
|
|
30
38
|
|
|
39
|
+
### Starting from Scratch
|
|
40
|
+
|
|
31
41
|
```bash
|
|
32
|
-
$ npx
|
|
42
|
+
$ npx continum init
|
|
33
43
|
|
|
34
44
|
┌ Continum Setup
|
|
35
45
|
│
|
|
46
|
+
◇ Set up a JavaScript framework first?
|
|
47
|
+
│ Yes
|
|
48
|
+
│
|
|
49
|
+
◇ What type of project are you building?
|
|
50
|
+
│ 🎨 Frontend (React, Vue, Svelte, etc.)
|
|
51
|
+
│
|
|
52
|
+
◇ Choose a frontend framework:
|
|
53
|
+
│ Next.js (App Router)
|
|
54
|
+
│
|
|
55
|
+
◆ Setting up nextjs-app...
|
|
56
|
+
│ ✓ nextjs-app installed successfully!
|
|
57
|
+
│
|
|
58
|
+
◇ Set up Continum AI compliance in your project?
|
|
59
|
+
│ Yes
|
|
60
|
+
│
|
|
61
|
+
◇ What kind of AI product are you building?
|
|
62
|
+
│ 💬 Customer support bot
|
|
63
|
+
│
|
|
64
|
+
...
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
### Existing Project
|
|
68
|
+
|
|
69
|
+
```bash
|
|
70
|
+
$ npx continum init
|
|
71
|
+
|
|
72
|
+
┌ Continum Setup
|
|
73
|
+
│
|
|
74
|
+
ℹ Detected framework: Next.js (App Router)
|
|
75
|
+
│
|
|
76
|
+
◇ Set up Continum AI compliance in your project?
|
|
77
|
+
│ Yes
|
|
78
|
+
│
|
|
36
79
|
◇ Set up Continum AI compliance in your project?
|
|
37
80
|
│ Yes
|
|
38
81
|
│
|
|
@@ -83,6 +126,32 @@ $ npx create-continum
|
|
|
83
126
|
|
|
84
127
|
## Features
|
|
85
128
|
|
|
129
|
+
### 🔍 Smart Framework Detection
|
|
130
|
+
|
|
131
|
+
The CLI automatically detects your existing framework:
|
|
132
|
+
- **Frontend:** Next.js (App/Pages Router), Nuxt, SvelteKit, Astro, React, Vue, Svelte
|
|
133
|
+
- **Backend:** NestJS, Fastify, Hono, Express
|
|
134
|
+
|
|
135
|
+
If no framework is detected, it offers to set one up for you!
|
|
136
|
+
|
|
137
|
+
### 🚀 Framework Setup (New!)
|
|
138
|
+
|
|
139
|
+
Start from scratch with your favorite framework:
|
|
140
|
+
|
|
141
|
+
**Frontend:**
|
|
142
|
+
- Next.js (App Router & Pages Router)
|
|
143
|
+
- Nuxt (Vue)
|
|
144
|
+
- SvelteKit
|
|
145
|
+
- Astro
|
|
146
|
+
|
|
147
|
+
**Backend:**
|
|
148
|
+
- Fastify
|
|
149
|
+
- NestJS
|
|
150
|
+
- Hono
|
|
151
|
+
- Express
|
|
152
|
+
|
|
153
|
+
The CLI will install and configure the framework, then set up Continum on top of it.
|
|
154
|
+
|
|
86
155
|
### 🎯 Smart Defaults
|
|
87
156
|
|
|
88
157
|
The CLI automatically:
|
|
@@ -106,7 +175,7 @@ Generates three example patterns:
|
|
|
106
175
|
|
|
107
176
|
### 🚀 Zero Installation
|
|
108
177
|
|
|
109
|
-
Run with `npx` - no global installation needed.
|
|
178
|
+
Run with `npx continum init` in any folder (even empty ones!) - no global installation needed.
|
|
110
179
|
|
|
111
180
|
## Configuration File
|
|
112
181
|
|
|
@@ -200,6 +269,24 @@ All webhook URLs must use HTTPS for security.
|
|
|
200
269
|
- Node.js >= 18.0.0
|
|
201
270
|
- A Continum API key (get one at https://app.continum.co)
|
|
202
271
|
|
|
272
|
+
## Getting Started from Scratch
|
|
273
|
+
|
|
274
|
+
Want to start a new project with Continum built-in? Just run:
|
|
275
|
+
|
|
276
|
+
```bash
|
|
277
|
+
mkdir my-ai-app
|
|
278
|
+
cd my-ai-app
|
|
279
|
+
npx continum init
|
|
280
|
+
```
|
|
281
|
+
|
|
282
|
+
The CLI will:
|
|
283
|
+
1. Ask if you want to set up a framework (Next.js, Fastify, etc.)
|
|
284
|
+
2. Install and configure your chosen framework
|
|
285
|
+
3. Set up Continum with your compliance requirements
|
|
286
|
+
4. Generate example code to get you started
|
|
287
|
+
|
|
288
|
+
You'll have a fully configured project in minutes!
|
|
289
|
+
|
|
203
290
|
## Get Your API Key
|
|
204
291
|
|
|
205
292
|
```bash
|
|
@@ -221,7 +308,7 @@ curl -X POST https://api.continum.io/customers \
|
|
|
221
308
|
|
|
222
309
|
## Next Steps
|
|
223
310
|
|
|
224
|
-
After running `npx
|
|
311
|
+
After running `npx continum init`:
|
|
225
312
|
|
|
226
313
|
1. Install the SDK:
|
|
227
314
|
```bash
|