cinatra 0.1.0 → 0.1.1
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 +17 -47
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -1,18 +1,20 @@
|
|
|
1
1
|
# cinatra
|
|
2
2
|
|
|
3
|
-
The command-line tool for
|
|
3
|
+
The command-line tool for [Cinatra](https://cinatra.ai) — the open-source AI platform you host yourself.
|
|
4
|
+
|
|
5
|
+
Cinatra lets you run AI agents, connect them to your own tools, data, and content, and put that to work across your apps and workflows — on infrastructure you control. This CLI is how you stand up a Cinatra instance and keep it running.
|
|
6
|
+
|
|
7
|
+
## Quick start
|
|
4
8
|
|
|
5
9
|
```sh
|
|
6
10
|
npx cinatra install
|
|
7
11
|
```
|
|
8
12
|
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
Every other command operates **on a Cinatra checkout** — a cloned copy of the Cinatra repository. After `install`, run them from inside that checkout (or point at one with `CINATRA_REPO_ROOT`).
|
|
13
|
+
This sets up a Cinatra instance from scratch — it checks your prerequisites, fetches Cinatra, creates your environment, starts the local services, and runs first-time setup. After that, run the other commands from inside your new Cinatra directory.
|
|
12
14
|
|
|
13
15
|
## Install
|
|
14
16
|
|
|
15
|
-
|
|
17
|
+
Run on demand, no install needed:
|
|
16
18
|
|
|
17
19
|
```sh
|
|
18
20
|
npx cinatra <command>
|
|
@@ -22,55 +24,23 @@ Or install globally:
|
|
|
22
24
|
|
|
23
25
|
```sh
|
|
24
26
|
npm install -g cinatra
|
|
25
|
-
cinatra <command>
|
|
26
27
|
```
|
|
27
28
|
|
|
28
|
-
Requires
|
|
29
|
-
|
|
30
|
-
## The checkout-driven model
|
|
31
|
-
|
|
32
|
-
This CLI is intentionally **thin**: it bundles no Cinatra application code. The heavy, version-sensitive internals it drives — the database **migration runner**, the **connector catalog**, and the **agent-skill** compiler — are resolved **from your checkout at runtime**, against the exact versions installed there. This keeps the published tool small and guarantees the runner code always matches the migrations and schema in the checkout it operates on.
|
|
29
|
+
Requires Node.js >= 20.
|
|
33
30
|
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
- `cinatra install` works from anywhere (it creates the checkout).
|
|
37
|
-
- All other commands need a checkout. They resolve it in this order:
|
|
38
|
-
1. `CINATRA_REPO_ROOT=<path-to-checkout>` if set, else
|
|
39
|
-
2. an upward search from your current directory for a Cinatra checkout.
|
|
40
|
-
|
|
41
|
-
If neither finds one, the command fails with a clear message rather than guessing.
|
|
31
|
+
## What you can do
|
|
42
32
|
|
|
43
33
|
```sh
|
|
44
|
-
#
|
|
45
|
-
|
|
46
|
-
cinatra setup
|
|
47
|
-
|
|
48
|
-
#
|
|
49
|
-
|
|
34
|
+
cinatra install # set up a new Cinatra instance from scratch
|
|
35
|
+
cinatra setup dev # provision a local development instance
|
|
36
|
+
cinatra setup prod # provision a production instance
|
|
37
|
+
cinatra db migrate # apply schema updates to an instance
|
|
38
|
+
cinatra status # check an instance's status
|
|
39
|
+
cinatra doctor # diagnose your local setup
|
|
40
|
+
cinatra agents install <name> # add an agent to your instance
|
|
50
41
|
```
|
|
51
42
|
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
```sh
|
|
55
|
-
cinatra install [--dir <path>] [--ref <main|tag|sha>] [--mode dev|prod]
|
|
56
|
-
cinatra setup dev # provision a local dev instance
|
|
57
|
-
cinatra setup prod # provision a production instance
|
|
58
|
-
cinatra db migrate [--down] # apply / revert core schema migrations
|
|
59
|
-
cinatra status # local or remote instance status
|
|
60
|
-
cinatra doctor [--strict] # diagnose the local setup
|
|
61
|
-
cinatra agents install <name> # resolve + install an agent dependency tree
|
|
62
|
-
```
|
|
63
|
-
|
|
64
|
-
Run `cinatra --help` for the full command list, and `cinatra <command> --help` for per-command options.
|
|
65
|
-
|
|
66
|
-
```sh
|
|
67
|
-
cinatra --help
|
|
68
|
-
cinatra --version
|
|
69
|
-
```
|
|
70
|
-
|
|
71
|
-
## Versioning
|
|
72
|
-
|
|
73
|
-
`cinatra --version` reports **this CLI's** own version. It is distinct from the Cinatra application version and from the `cinatra.ai/v1` API version.
|
|
43
|
+
Most commands run from inside your Cinatra directory. Run `cinatra --help` for the full command list and `cinatra <command> --help` for per-command options.
|
|
74
44
|
|
|
75
45
|
## License
|
|
76
46
|
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "cinatra",
|
|
3
|
-
"description": "
|
|
4
|
-
"version": "0.1.
|
|
3
|
+
"description": "Install, run, and maintain your own self-hosted Cinatra instance — the open-source AI platform — from the command line.",
|
|
4
|
+
"version": "0.1.1",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"license": "Apache-2.0",
|
|
7
7
|
"bin": {
|