forkit-connect 0.1.0 → 0.1.3

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.
Files changed (13) hide show
  1. package/README.md +32 -4
  2. package/dist/cli.js +390 -99
  3. package/dist/launcher.js +1451 -15
  4. package/dist/v1/api.d.ts +62 -1
  5. package/dist/v1/api.js +131 -2
  6. package/dist/v1/credential-store.d.ts +1 -0
  7. package/dist/v1/credential-store.js +15 -3
  8. package/dist/v1/service.d.ts +57 -3
  9. package/dist/v1/service.js +633 -60
  10. package/dist/v1/state.d.ts +1 -0
  11. package/dist/v1/state.js +32 -12
  12. package/dist/v1/types.d.ts +55 -1
  13. package/package.json +9 -9
package/README.md CHANGED
@@ -2,12 +2,18 @@
2
2
 
3
3
  Forkit Connect is the local engine for discovering AI runtimes, reviewing what is running on-device, and preparing metadata-only Passport and lifecycle handoff into Forkit.dev.
4
4
 
5
- ## Install Surface
5
+ Naming convention:
6
6
 
7
+ - Product name: Forkit Connect
8
+ - Command name: `forkit-connect`
7
9
  - Package name: `@forkit/connect`
10
+
11
+ ## Install Surface
12
+
13
+ - Package name: `forkit-connect`
8
14
  - Public binary: `forkit-connect`
9
- - Intended bootstrap: `npx forkit-connect ...` once published
10
- - Current pre-publish workflow: install from a local tarball generated with `npm pack`
15
+ - Published bootstrap: `npx forkit-connect ...`
16
+ - Global install: `npm install -g forkit-connect`
11
17
  - Current Ubuntu shortcut: `pnpm run install:ubuntu` installs into user space without `sudo`
12
18
 
13
19
  ## Ubuntu Install
@@ -19,6 +25,14 @@ Requirements:
19
25
  - `pnpm` for local packaging from this repo
20
26
  - On Linux, `libsecret-tools` is recommended so Forkit Connect can store login credentials in Secret Service
21
27
 
28
+ Published npm install:
29
+
30
+ ```bash
31
+ npx forkit-connect --help
32
+ npm install -g forkit-connect
33
+ forkit-connect status
34
+ ```
35
+
22
36
  From `integrations/connect`:
23
37
 
24
38
  ```bash
@@ -49,11 +63,25 @@ If `~/.local/bin` is already on your `PATH`, the command is immediately accessib
49
63
  - `forkit-connect status` — show public Connect readiness status
50
64
  - `forkit-connect changes` — view collected local evidence, runtime signal history, and pending sync items
51
65
  - `forkit-connect start` — start the local daemon loop
66
+ - `forkit-connect stop` — stop the background daemon without deleting local state
67
+ - `forkit-connect uninstall` — preview a cautious uninstall plan and write local backup logs
68
+ - `forkit-connect uninstall --confirm` — stop the daemon, clear stale notification waiters, and preserve state
69
+ - `forkit-connect uninstall --confirm --purge-state` — additionally remove local state after writing a backup
52
70
 
53
71
  ## Advanced Commands
54
72
 
55
73
  Advanced flows remain available under the same binary, including `connect`, `review`, `daemon`, `config`, `pulse`, `c2`, `train`, `agent`, and notification utilities.
56
74
 
75
+ Useful notification diagnostics:
76
+
77
+ ```bash
78
+ forkit-connect notify logs
79
+ forkit-connect notify cleanup --dry-run
80
+ forkit-connect notify cleanup
81
+ ```
82
+
83
+ `notify cleanup` only targets stale Forkit Connect desktop notification waiter processes. It does not delete local state or credentials.
84
+
57
85
  ## Privacy and Security Posture
58
86
 
59
87
  - Session credentials are stored outside `state.v1.json`.
@@ -78,7 +106,7 @@ Then install the generated tarball into a clean directory:
78
106
  mkdir -p /tmp/forkit-connect-smoke
79
107
  cd /tmp/forkit-connect-smoke
80
108
  npm init -y
81
- npm install /absolute/path/to/forkit-connect-0.1.0.tgz
109
+ npm install /absolute/path/to/forkit-connect-0.1.1.tgz
82
110
  npx forkit-connect --help
83
111
  npx forkit-connect status
84
112
  npx forkit-connect inbox