@devicelink/dlink 0.2.2 → 0.3.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 +24 -37
- package/index.js +343 -161
- package/index.js.map +4 -4
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,8 +1,6 @@
|
|
|
1
1
|
# @devicelink/dlink
|
|
2
2
|
|
|
3
|
-
DeviceLink
|
|
4
|
-
|
|
5
|
-
Share files from your machine with AI assistants (ChatGPT, Claude, etc.) through the Model Context Protocol (MCP). Your files never leave your device — they're streamed in real-time with your explicit permission.
|
|
3
|
+
DeviceLink lets you share folders from your computer with AI assistants (like ChatGPT) safely. Nothing is uploaded to the cloud to sit on a server: files stay on your machine until you allow access, and you stay in control.
|
|
6
4
|
|
|
7
5
|
## Install
|
|
8
6
|
|
|
@@ -10,58 +8,47 @@ Share files from your machine with AI assistants (ChatGPT, Claude, etc.) through
|
|
|
10
8
|
npm install -g @devicelink/dlink
|
|
11
9
|
```
|
|
12
10
|
|
|
13
|
-
## Quick
|
|
11
|
+
## Quick start
|
|
14
12
|
|
|
15
13
|
```bash
|
|
16
14
|
# Sign in with your DeviceLink account
|
|
17
15
|
dlink signin
|
|
18
16
|
|
|
19
|
-
#
|
|
17
|
+
# Pick a folder to share
|
|
20
18
|
dlink share /path/to/project
|
|
21
19
|
|
|
22
|
-
#
|
|
20
|
+
# You're set: your AI can use that folder when you connect it through DeviceLink
|
|
23
21
|
```
|
|
24
22
|
|
|
25
23
|
## Commands
|
|
26
24
|
|
|
27
|
-
| Command |
|
|
28
|
-
|
|
29
|
-
| `dlink signin` |
|
|
30
|
-
| `dlink signout` | Sign out
|
|
31
|
-
| `dlink share <path>` | Share a
|
|
32
|
-
| `dlink status` |
|
|
33
|
-
| `dlink debug on/off` | Toggle debug logging |
|
|
34
|
-
|
|
35
|
-
## How It Works
|
|
36
|
-
|
|
37
|
-
1. **Sign in** — authenticate via Google OAuth using a device code flow
|
|
38
|
-
2. **Share directories** — choose which folders to make available
|
|
39
|
-
3. **Connect** — the agent maintains a secure WebSocket connection to the DeviceLink bridge
|
|
40
|
-
4. **Use** — AI assistants call tools (list files, read files, search, grep) through MCP
|
|
41
|
-
5. **Control** — you see every tool call in real-time and can disconnect anytime
|
|
42
|
-
|
|
43
|
-
## Security
|
|
25
|
+
| Command | What it does |
|
|
26
|
+
|---------|----------------|
|
|
27
|
+
| `dlink signin` | Sign in to DeviceLink |
|
|
28
|
+
| `dlink signout` | Sign out on this computer |
|
|
29
|
+
| `dlink share <path>` | Share a folder with your AI |
|
|
30
|
+
| `dlink status` | See whether you're connected |
|
|
44
31
|
|
|
45
|
-
|
|
46
|
-
- **Ed25519 proof-of-possession** — device identity is cryptographically verified
|
|
47
|
-
- **Encrypted credential storage** — AES-256-GCM with machine-bound keys
|
|
48
|
-
- **Shared directory boundaries** — path traversal protection, symlink escape prevention
|
|
49
|
-
- **Short-lived tokens** — access tokens expire in 30 seconds, auto-refreshed
|
|
32
|
+
## How it works
|
|
50
33
|
|
|
51
|
-
|
|
34
|
+
1. **Sign in** with your account (you'll use your browser when asked).
|
|
35
|
+
2. **Pick folders** you want the AI to be able to read.
|
|
36
|
+
3. **Stay connected** so requests can reach your computer securely.
|
|
37
|
+
4. **Use your AI** as usual: it can list and read files in the folders you shared.
|
|
38
|
+
5. **Stop anytime**: sign out or disconnect if you want access to end.
|
|
52
39
|
|
|
53
|
-
|
|
40
|
+
## Security & privacy
|
|
54
41
|
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
42
|
+
- Your files are not kept on our servers for browsing; access happens when you're connected and allow it.
|
|
43
|
+
- Your device is checked so only your account can use your shared folders.
|
|
44
|
+
- Sign-in details are stored encrypted on this computer.
|
|
45
|
+
- Shared folders are limited to what you picked, so the AI can't wander the rest of your disk.
|
|
46
|
+
- Access is short-lived and refreshed automatically so old keys don't stick around.
|
|
60
47
|
|
|
61
48
|
## Requirements
|
|
62
49
|
|
|
63
|
-
- Node.js 20 or
|
|
64
|
-
- Internet
|
|
50
|
+
- [Node.js](https://nodejs.org/) version 20 or newer
|
|
51
|
+
- Internet access to sign in and stay connected
|
|
65
52
|
|
|
66
53
|
## License
|
|
67
54
|
|