aidran 0.3.0 → 0.5.0
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 +18 -12
- package/package.json +4 -4
package/README.md
CHANGED
|
@@ -5,28 +5,34 @@ One-install convenience package for the [AIDRAN](https://aidran.ai) discourse-in
|
|
|
5
5
|
## Install
|
|
6
6
|
|
|
7
7
|
```sh
|
|
8
|
-
npm install aidran
|
|
9
|
-
# or
|
|
10
|
-
pnpm add aidran
|
|
8
|
+
npm install -g aidran
|
|
9
|
+
# or: pnpm add -g aidran
|
|
11
10
|
```
|
|
12
11
|
|
|
13
|
-
|
|
12
|
+
Global install puts the `aidran` binary on your PATH so you can run it as a bare command. Prefer a project-local install? Use `npm install aidran` and invoke via `npx aidran`.
|
|
14
13
|
|
|
15
|
-
|
|
14
|
+
## What you get
|
|
16
15
|
|
|
17
|
-
- `aidran` binary on your PATH
|
|
16
|
+
- The `aidran` binary on your PATH — interactive wizard + non-interactive subcommands
|
|
18
17
|
- TypeScript types and Zod schemas from [`@aidran/contracts`](https://www.npmjs.com/package/@aidran/contracts)
|
|
19
18
|
- Drizzle ORM schemas + bundled migrations from [`@aidran/db`](https://www.npmjs.com/package/@aidran/db)
|
|
20
19
|
|
|
21
20
|
## Quickstart
|
|
22
21
|
|
|
23
22
|
```sh
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
23
|
+
npm install -g aidran
|
|
24
|
+
aidran # launches the interactive setup wizard
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
The wizard prompts for `DATABASE_URL`, generates an `AIDRAN_API_KEY`, writes config files, applies the migrations, and verifies the schema in one flow.
|
|
28
|
+
|
|
29
|
+
Already past the wizard? The same commands work directly:
|
|
30
|
+
|
|
31
|
+
```sh
|
|
32
|
+
aidran init # scaffold .env.example + drizzle.config.ts
|
|
33
|
+
aidran migrate # apply migrations to $DATABASE_URL
|
|
34
|
+
aidran verify # confirm schema is healthy
|
|
35
|
+
aidran help # see all commands
|
|
30
36
|
```
|
|
31
37
|
|
|
32
38
|
## Using the types and schemas
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "aidran",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.5.0",
|
|
4
4
|
"description": "AIDRAN — one install for the discourse-intelligence platform. Re-exports @aidran/contracts and @aidran/db, plus the @aidran/cli binary as `aidran`.",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"aidran",
|
|
@@ -54,9 +54,9 @@
|
|
|
54
54
|
"NOTICE"
|
|
55
55
|
],
|
|
56
56
|
"dependencies": {
|
|
57
|
-
"@aidran/
|
|
58
|
-
"@aidran/
|
|
59
|
-
"@aidran/
|
|
57
|
+
"@aidran/contracts": "0.5.0",
|
|
58
|
+
"@aidran/db": "0.5.0",
|
|
59
|
+
"@aidran/cli": "0.5.0"
|
|
60
60
|
},
|
|
61
61
|
"devDependencies": {
|
|
62
62
|
"@types/node": "^22.9.0",
|