@suronai/cli 0.1.9 → 0.1.11
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 +49 -17
- package/dist/commands/init.js +12 -3
- package/dist/commands/init.js.map +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# @suronai/cli
|
|
2
2
|
|
|
3
|
-
CLI for Suron —
|
|
3
|
+
CLI for Suron — configure your deployment and manage apps.
|
|
4
4
|
|
|
5
5
|
## Install
|
|
6
6
|
|
|
@@ -8,40 +8,72 @@ CLI for Suron — link your Telegram account and manage secrets.
|
|
|
8
8
|
npm install -g @suronai/cli
|
|
9
9
|
```
|
|
10
10
|
|
|
11
|
-
##
|
|
11
|
+
## Commands
|
|
12
|
+
|
|
13
|
+
### `suron login`
|
|
12
14
|
|
|
13
|
-
|
|
15
|
+
Prompts for your Convex deployment URL, verifies the backend is reachable, and saves the URL to `~/.suron-config`.
|
|
14
16
|
|
|
15
17
|
```bash
|
|
16
|
-
|
|
18
|
+
suron login
|
|
17
19
|
```
|
|
18
20
|
|
|
19
|
-
|
|
21
|
+
### `suron init`
|
|
20
22
|
|
|
21
|
-
|
|
22
|
-
Links your Telegram account. Opens a Telegram bot URL, tap Start. Saves `VAULT_API_KEY` to `~/.suron`.
|
|
23
|
+
Run inside your project directory. Does everything needed to protect your app with Suron:
|
|
23
24
|
|
|
24
|
-
|
|
25
|
-
|
|
25
|
+
1. Encrypts `.env` in-place with dotenvx
|
|
26
|
+
2. Registers your app in Convex (stores the encrypted private key)
|
|
27
|
+
3. Installs `@suronai/sdk` into your project (detects npm / pnpm / yarn / bun)
|
|
28
|
+
4. Writes `.suron.json` with your app name and ID
|
|
29
|
+
5. Deletes `.env.keys`
|
|
26
30
|
|
|
27
31
|
```bash
|
|
28
32
|
cd my-project
|
|
29
33
|
suron init
|
|
30
|
-
|
|
31
|
-
|
|
34
|
+
|
|
35
|
+
# optional: set a custom app name
|
|
36
|
+
suron init --name my-app
|
|
32
37
|
```
|
|
33
38
|
|
|
39
|
+
After `suron init`, both `.env` and `.suron.json` are safe to commit.
|
|
40
|
+
|
|
34
41
|
### `suron whoami`
|
|
35
|
-
|
|
42
|
+
|
|
43
|
+
Prints the configured Convex API URL.
|
|
44
|
+
|
|
45
|
+
```bash
|
|
46
|
+
suron whoami
|
|
47
|
+
```
|
|
36
48
|
|
|
37
49
|
### `suron rotate`
|
|
38
|
-
|
|
50
|
+
|
|
51
|
+
Re-encrypts `.env` with a new private key, sends the new key to Convex, deletes `.env.keys`.
|
|
52
|
+
|
|
53
|
+
```bash
|
|
54
|
+
suron rotate
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
Use this if your private key may have been compromised, or as a routine rotation.
|
|
58
|
+
|
|
59
|
+
---
|
|
60
|
+
|
|
61
|
+
## Configuration
|
|
62
|
+
|
|
63
|
+
The CLI reads `SURON_API_URL` from the environment first, then falls back to `~/.suron-config`.
|
|
64
|
+
|
|
65
|
+
```bash
|
|
66
|
+
# Override without running suron login:
|
|
67
|
+
export SURON_API_URL=https://your-deployment.convex.site
|
|
68
|
+
```
|
|
69
|
+
|
|
70
|
+
---
|
|
39
71
|
|
|
40
72
|
## Files
|
|
41
73
|
|
|
42
74
|
| File | Commit? | Notes |
|
|
43
75
|
|---|---|---|
|
|
44
|
-
| `.suron.json` | yes | app name + id |
|
|
45
|
-
| `.env` | yes | encrypted by dotenvx |
|
|
46
|
-
|
|
|
47
|
-
|
|
|
76
|
+
| `.suron.json` | ✅ yes | app name + id, no secrets |
|
|
77
|
+
| `.env` | ✅ yes | encrypted by dotenvx |
|
|
78
|
+
| `.env.keys` | ⛔ no | deleted automatically by `suron init` |
|
|
79
|
+
| `~/.suron-config` | ⛔ no | CLI config — lives on developer machine only |
|
package/dist/commands/init.js
CHANGED
|
@@ -9,7 +9,7 @@ const config_1 = require("../utils/config");
|
|
|
9
9
|
const dotenvx_1 = require("../utils/dotenvx");
|
|
10
10
|
exports.initCommand = new commander_1.Command("init")
|
|
11
11
|
.description("Encrypt .env and register this app with Suron")
|
|
12
|
-
.option("--
|
|
12
|
+
.option("--app <name>", "App name (skips interactive prompt)")
|
|
13
13
|
.action(async (opts) => {
|
|
14
14
|
const cwd = process.cwd();
|
|
15
15
|
const apiUrl = (0, config_1.requireApiUrl)();
|
|
@@ -18,7 +18,16 @@ exports.initCommand = new commander_1.Command("init")
|
|
|
18
18
|
console.error(" Create a .env file first, then run: suron init");
|
|
19
19
|
process.exit(1);
|
|
20
20
|
}
|
|
21
|
-
const
|
|
21
|
+
const suggested = require("path").basename(cwd) || "my-project";
|
|
22
|
+
let appName;
|
|
23
|
+
if (opts.app) {
|
|
24
|
+
appName = opts.app;
|
|
25
|
+
console.log(`[suron] App name: ${appName}`);
|
|
26
|
+
}
|
|
27
|
+
else {
|
|
28
|
+
const input = await (0, config_1.prompt)(` App name [${suggested}]: `);
|
|
29
|
+
appName = input.trim() || suggested;
|
|
30
|
+
}
|
|
22
31
|
console.log(`[suron] Encrypting .env with dotenvx...`);
|
|
23
32
|
try {
|
|
24
33
|
(0, dotenvx_1.encryptDotenv)(cwd);
|
|
@@ -58,7 +67,7 @@ exports.initCommand = new commander_1.Command("init")
|
|
|
58
67
|
}
|
|
59
68
|
const data = (await res.json());
|
|
60
69
|
(0, dotenvx_1.deleteKeysFile)(cwd);
|
|
61
|
-
(0, fs_1.writeFileSync)((0, path_1.join)(cwd, ".suron.json"), JSON.stringify({ app: appName, id: data.app_id }, null, 2) + "\n", "utf-8");
|
|
70
|
+
(0, fs_1.writeFileSync)((0, path_1.join)(cwd, ".suron.json"), JSON.stringify({ app: appName, id: data.app_id, api_url: apiUrl }, null, 2) + "\n", "utf-8");
|
|
62
71
|
// Install @suronai/sdk into the project
|
|
63
72
|
const pkgJsonPath = (0, path_1.join)(cwd, "package.json");
|
|
64
73
|
if ((0, fs_1.existsSync)(pkgJsonPath)) {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"init.js","sourceRoot":"","sources":["../../src/commands/init.ts"],"names":[],"mappings":";;;AAAA,yCAAoC;AACpC,2BAA6D;AAC7D,+BAA4B;AAC5B,iDAAyC;AACzC,
|
|
1
|
+
{"version":3,"file":"init.js","sourceRoot":"","sources":["../../src/commands/init.ts"],"names":[],"mappings":";;;AAAA,yCAAoC;AACpC,2BAA6D;AAC7D,+BAA4B;AAC5B,iDAAyC;AACzC,4CAAwD;AACxD,8CAAiF;AAEpE,QAAA,WAAW,GAAG,IAAI,mBAAO,CAAC,MAAM,CAAC;KAC3C,WAAW,CAAC,+CAA+C,CAAC;KAC5D,MAAM,CAAC,cAAc,EAAE,qCAAqC,CAAC;KAC7D,MAAM,CAAC,KAAK,EAAE,IAAsB,EAAE,EAAE;IACvC,MAAM,GAAG,GAAG,OAAO,CAAC,GAAG,EAAE,CAAC;IAC1B,MAAM,MAAM,GAAG,IAAA,sBAAa,GAAE,CAAC;IAE/B,IAAI,CAAC,IAAA,eAAU,EAAC,IAAA,WAAI,EAAC,GAAG,EAAE,MAAM,CAAC,CAAC,EAAE,CAAC;QACnC,OAAO,CAAC,KAAK,CAAC,4CAA4C,CAAC,CAAC;QAC5D,OAAO,CAAC,KAAK,CAAC,uDAAuD,CAAC,CAAC;QACvE,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC;IAED,MAAM,SAAS,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,YAAY,CAAC;IAChE,IAAI,OAAe,CAAC;IACpB,IAAI,IAAI,CAAC,GAAG,EAAE,CAAC;QACb,OAAO,GAAG,IAAI,CAAC,GAAG,CAAC;QACnB,OAAO,CAAC,GAAG,CAAC,qBAAqB,OAAO,EAAE,CAAC,CAAC;IAC9C,CAAC;SAAM,CAAC;QACN,MAAM,KAAK,GAAG,MAAM,IAAA,eAAM,EAAC,eAAe,SAAS,KAAK,CAAC,CAAC;QAC1D,OAAO,GAAG,KAAK,CAAC,IAAI,EAAE,IAAI,SAAS,CAAC;IACtC,CAAC;IAED,OAAO,CAAC,GAAG,CAAC,yCAAyC,CAAC,CAAC;IAEvD,IAAI,CAAC;QACH,IAAA,uBAAa,EAAC,GAAG,CAAC,CAAC;IACrB,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,OAAO,CAAC,KAAK,CAAC,qCAAqC,GAAG,EAAE,CAAC,CAAC;QAC1D,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC;IAED,IAAI,UAAkB,CAAC;IACvB,IAAI,CAAC;QACH,UAAU,GAAG,IAAA,wBAAc,EAAC,GAAG,CAAC,CAAC;IACnC,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,OAAO,CAAC,KAAK,CAAC,UAAU,GAAG,EAAE,CAAC,CAAC;QAC/B,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC;IAED,OAAO,CAAC,GAAG,CAAC,4BAA4B,CAAC,CAAC;IAE1C,IAAI,GAAa,CAAC;IAClB,IAAI,CAAC;QACH,GAAG,GAAG,MAAM,KAAK,CAAC,GAAG,MAAM,mBAAmB,EAAE;YAC9C,MAAM,EAAE,MAAM;YACd,OAAO,EAAE,EAAE,cAAc,EAAE,kBAAkB,EAAE;YAC/C,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC;gBACnB,IAAI,EAAE,OAAO;gBACb,WAAW,EAAE,UAAU;aACxB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,OAAO,CAAC,KAAK,CAAC,qCAAqC,GAAG,EAAE,CAAC,CAAC;QAC1D,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC;IAED,IAAI,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC;QACZ,MAAM,IAAI,GAAG,MAAM,GAAG,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,EAAE,CAAC,CAAC;QAC9C,OAAO,CAAC,KAAK,CAAC,+BAA+B,GAAG,CAAC,MAAM,MAAM,IAAI,EAAE,CAAC,CAAC;QACrE,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC;IAED,MAAM,IAAI,GAAG,CAAC,MAAM,GAAG,CAAC,IAAI,EAAE,CAAuB,CAAC;IAEtD,IAAA,wBAAc,EAAC,GAAG,CAAC,CAAC;IAEpB,IAAA,kBAAa,EACX,IAAA,WAAI,EAAC,GAAG,EAAE,aAAa,CAAC,EACxB,IAAI,CAAC,SAAS,CAAC,EAAE,GAAG,EAAE,OAAO,EAAE,EAAE,EAAE,IAAI,CAAC,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC,GAAG,IAAI,EAClF,OAAO,CACR,CAAC;IAEF,wCAAwC;IACxC,MAAM,WAAW,GAAG,IAAA,WAAI,EAAC,GAAG,EAAE,cAAc,CAAC,CAAC;IAC9C,IAAI,IAAA,eAAU,EAAC,WAAW,CAAC,EAAE,CAAC;QAC5B,IAAI,gBAAgB,GAAG,KAAK,CAAC;QAC7B,IAAI,CAAC;YACH,MAAM,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,IAAA,iBAAY,EAAC,WAAW,EAAE,OAAO,CAAC,CAAC,CAAC;YAC3D,gBAAgB,GAAG,CAAC,CAAC,CACnB,GAAG,CAAC,YAAY,EAAE,CAAC,cAAc,CAAC;gBAClC,GAAG,CAAC,eAAe,EAAE,CAAC,cAAc,CAAC,CACtC,CAAC;QACJ,CAAC;QAAC,MAAM,CAAC,CAAC,yBAAyB,CAAC,CAAC;QAErC,IAAI,gBAAgB,EAAE,CAAC;YACrB,OAAO,CAAC,GAAG,CAAC,gEAAgE,CAAC,CAAC;QAChF,CAAC;aAAM,CAAC;YACN,OAAO,CAAC,GAAG,CAAC,oCAAoC,CAAC,CAAC;YAClD,MAAM,EAAE,GAAG,oBAAoB,CAAC,GAAG,CAAC,CAAC;YACrC,IAAI,CAAC;gBACH,IAAA,wBAAQ,EAAC,GAAG,EAAE,IAAI,QAAQ,CAAC,EAAE,CAAC,eAAe,EAAE,EAAE,GAAG,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC,CAAC;YAC5E,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;gBACb,OAAO,CAAC,KAAK,CAAC,0CAA0C,GAAG,EAAE,CAAC,CAAC;gBAC/D,OAAO,CAAC,KAAK,CAAC,+CAA+C,CAAC,CAAC;YACjE,CAAC;QACH,CAAC;IACH,CAAC;SAAM,CAAC;QACN,OAAO,CAAC,GAAG,CAAC,sDAAsD,CAAC,CAAC;QACpE,OAAO,CAAC,GAAG,CAAC,gDAAgD,CAAC,CAAC;IAChE,CAAC;IAED,OAAO,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC;IAC7B,OAAO,CAAC,GAAG,CAAC,4CAA4C,CAAC,CAAC;IAC1D,OAAO,CAAC,GAAG,CAAC,2BAA2B,CAAC,CAAC;IACzC,OAAO,CAAC,GAAG,CAAC,8CAA8C,CAAC,CAAC;IAC5D,OAAO,CAAC,GAAG,CAAC,gCAAgC,CAAC,CAAC;IAC9C,OAAO,CAAC,GAAG,CAAC,wCAAwC,CAAC,CAAC;IACtD,OAAO,CAAC,GAAG,CAAC,0CAA0C,CAAC,CAAC;IACxD,OAAO,CAAC,GAAG,CAAC,qBAAqB,CAAC,CAAC;AACrC,CAAC,CAAC,CAAC;AAEL,SAAS,oBAAoB,CAAC,GAAW;IACvC,IAAI,IAAA,eAAU,EAAC,IAAA,WAAI,EAAC,GAAG,EAAE,gBAAgB,CAAC,CAAC;QAAE,OAAO,MAAM,CAAC;IAC3D,IAAI,IAAA,eAAU,EAAC,IAAA,WAAI,EAAC,GAAG,EAAE,WAAW,CAAC,CAAC;QAAO,OAAO,MAAM,CAAC;IAC3D,IAAI,IAAA,eAAU,EAAC,IAAA,WAAI,EAAC,GAAG,EAAE,WAAW,CAAC,CAAC;QAAO,OAAO,KAAK,CAAC;IAC1D,OAAO,KAAK,CAAC;AACf,CAAC;AAED,SAAS,QAAQ,CAAC,EAAU;IAC1B,IAAI,EAAE,KAAK,MAAM;QAAE,OAAO,KAAK,CAAC;IAChC,IAAI,EAAE,KAAK,MAAM;QAAE,OAAO,KAAK,CAAC;IAChC,IAAI,EAAE,KAAK,KAAK;QAAG,OAAO,KAAK,CAAC;IAChC,OAAO,SAAS,CAAC;AACnB,CAAC"}
|