nterminal 1.2.1 → 1.2.2

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 CHANGED
@@ -22,18 +22,20 @@ Browser
22
22
 
23
23
  ## Quick Start
24
24
 
25
- Clone the repo on the machine that should become the **main server**, then run:
25
+ Install NTerminal on the machine that should become the **main server**, then run:
26
26
 
27
27
  ```bash
28
- npm run onboarding
28
+ npm install -g nterminal
29
+ nterminal onboarding
29
30
  ```
30
31
 
31
32
  Choose `main`. Onboarding installs dependencies, writes `.env`, creates secrets, sets your password and TOTP, and can build/start the service.
32
33
 
33
- To add another machine, clone the repo there and run the same command:
34
+ To add another machine, install NTerminal there and run the same command:
34
35
 
35
36
  ```bash
36
- npm run onboarding
37
+ npm install -g nterminal
38
+ nterminal onboarding
37
39
  ```
38
40
 
39
41
  Choose `secondary`, enter the main server URL, log in once from the CLI, and the server registers itself in the main UI.
@@ -42,15 +44,14 @@ After onboarding finishes, open the URL printed in the final summary and log in
42
44
 
43
45
  See [docs/onboarding.md](docs/onboarding.md) for the full main/secondary setup flow, nginx/TLS automation, and local-only setup.
44
46
 
45
- After NTerminal is published to npm, package installs can use:
47
+ For source checkouts, clone the repo and run the npm script instead:
46
48
 
47
49
  ```bash
48
- npm install -g nterminal
49
- nterminal onboarding
50
+ npm run onboarding
50
51
  ```
51
52
 
52
- Package installs keep runtime config and state under `~/.nterminal` so package updates do not overwrite local sessions or secrets.
53
- Use a user-writable npm global prefix if you want in-app updates to run without sudo.
53
+ The source script runs the same onboarding flow through the local checkout.
54
+ Package installs keep runtime config and state under `~/.nterminal` so package updates do not overwrite local sessions or secrets. Use a user-writable npm global prefix if you want in-app updates to run without sudo.
54
55
 
55
56
  ## Key Features
56
57
 
@@ -108,8 +109,8 @@ Use a user-writable npm global prefix if you want in-app updates to run without
108
109
  ### Simple npm Toolchain
109
110
 
110
111
  - The project uses npm so source checkouts and package installs use the same package manager.
111
- - `npm run onboarding` runs install automatically on fresh checkouts.
112
- - The `nterminal` CLI entrypoint is prepared for global npm installs.
112
+ - `nterminal onboarding` runs the guided setup for npm package installs.
113
+ - `npm run onboarding` runs the same setup from a source checkout and installs dependencies automatically.
113
114
 
114
115
  ## Requirements
115
116
 
@@ -126,6 +127,17 @@ npm rebuild node-pty --build-from-source
126
127
 
127
128
  ## Common Commands
128
129
 
130
+ For npm package installs:
131
+
132
+ ```bash
133
+ nterminal onboarding
134
+ nterminal status
135
+ nterminal logs
136
+ nterminal restart
137
+ ```
138
+
139
+ For source checkouts:
140
+
129
141
  ```bash
130
142
  npm run onboarding
131
143
  npm run service:status
@@ -19,7 +19,13 @@ npm run generate:secrets
19
19
 
20
20
  Paste the generated `NTERMINAL_SESSION_SECRET=...` value into `.env`.
21
21
 
22
- For normal installs, prefer:
22
+ For normal package installs, prefer:
23
+
24
+ ```bash
25
+ nterminal onboarding
26
+ ```
27
+
28
+ For source checkouts:
23
29
 
24
30
  ```bash
25
31
  npm run onboarding
@@ -1,28 +1,30 @@
1
1
  # Onboarding
2
2
 
3
- NTerminal uses one interactive command for both the main server and secondary servers:
3
+ NTerminal uses one interactive command for both the main server and secondary servers.
4
+
5
+ For npm package installs:
4
6
 
5
7
  ```bash
6
- npm run onboarding
8
+ npm install -g nterminal
9
+ nterminal onboarding
7
10
  ```
8
11
 
9
- `npm install` runs automatically as the `preonboarding` hook, so a fresh checkout does not need a separate install step.
12
+ CLI package installs store `.env`, state, pid, and log files under `~/.nterminal`. Install with a user-writable npm global prefix so in-app updates can run `npm install -g nterminal@latest` without sudo.
10
13
 
11
- After npm publication, package installs use the CLI directly:
14
+ For source checkouts:
12
15
 
13
16
  ```bash
14
- npm install -g nterminal
15
- nterminal onboarding
17
+ npm run onboarding
16
18
  ```
17
19
 
18
- CLI package installs store `.env`, state, pid, and log files under `~/.nterminal`. Install with a user-writable npm global prefix so in-app updates can run `npm install -g nterminal@latest` without sudo.
20
+ `npm install` runs automatically as the `preonboarding` hook, so a fresh checkout does not need a separate install step.
19
21
 
20
22
  ## Main Server
21
23
 
22
24
  Run onboarding on the machine that should serve the browser UI:
23
25
 
24
26
  ```bash
25
- npm run onboarding
27
+ nterminal onboarding
26
28
  ```
27
29
 
28
30
  Choose `main`.
@@ -43,7 +45,7 @@ The final summary prints the public URL, internal bind, and next steps.
43
45
  Run onboarding on each additional machine that should appear in the main UI:
44
46
 
45
47
  ```bash
46
- npm run onboarding
48
+ nterminal onboarding
47
49
  ```
48
50
 
49
51
  Choose `secondary`.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "nterminal",
3
- "version": "1.2.1",
3
+ "version": "1.2.2",
4
4
  "license": "GPL-3.0-only",
5
5
  "type": "module",
6
6
  "packageManager": "npm@10.9.7",