@devicelink/dlink 0.3.3 → 0.3.8

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 (5) hide show
  1. package/.env.production +3 -5
  2. package/README.md +45 -9
  3. package/index.js +4 -8315
  4. package/package.json +8 -6
  5. package/index.js.map +0 -7
package/.env.production CHANGED
@@ -1,8 +1,6 @@
1
- # Production environment configuration
2
- # For production deployment
1
+ # Generated by scripts/generate-agent-env.mjs - do not edit by hand.
2
+ # Target: production
3
3
 
4
- # Control server URL (HTTPS)
5
4
  DLINK_CONTROL_URL=https://api.devicelink.ai
6
-
7
- # Bridge WebSocket URL (WSS - secure WebSocket)
8
5
  DLINK_BRIDGE_URL=wss://api.devicelink.ai/ws
6
+ DEVICELINK_ENV=production
package/README.md CHANGED
@@ -1,6 +1,6 @@
1
1
  # @devicelink/dlink
2
2
 
3
- DeviceLink lets you share folders from your computer with AI assistants (like ChatGPT) safely. Nothing is uploaded - files stay on your machine and are streamed in real-time with your explicit permission.
3
+ DeviceLink lets you share folders from your computer with AI assistants - Claude, ChatGPT, and more. Nothing is uploaded. Files stay on your machine and are streamed in real-time with your explicit permission.
4
4
 
5
5
  ## Install
6
6
 
@@ -14,28 +14,39 @@ Requires Node.js 20+.
14
14
 
15
15
  ### 1. Create your account
16
16
 
17
- Sign in at [devicelink.ai](https://devicelink.ai) with Google. We create a workspace for you automatically. No setup needed.
17
+ Sign in at [devicelink.ai](https://devicelink.ai) with Google. A workspace is created for you automatically.
18
18
 
19
- ### 2. Install the agent
19
+ ### 2. Install and run the agent
20
20
 
21
- Go to the folder you want to share, open a terminal there, install the CLI, and run it. Sign in with the same Google account to link your device.
21
+ Open a terminal in the folder you want to share, then:
22
22
 
23
23
  ```bash
24
24
  npm install -g @devicelink/dlink
25
25
  dlink
26
26
  ```
27
27
 
28
- ### 3. Use with ChatGPT
28
+ Type `signin` in the agent console and sign in with the same Google account.
29
29
 
30
- Add DeviceLink as a connected app in ChatGPT and sign in with the same Google account. Then just ask "list my files using DeviceLink".
30
+ ### 3. Connect an AI platform
31
+
32
+ Add DeviceLink as a connector in your AI platform of choice. Use the MCP endpoint:
33
+
34
+ ```
35
+ https://api.devicelink.ai/mcp
36
+ ```
37
+
38
+ - **Claude** - Settings → Integrations → Add connector
39
+ - **ChatGPT** - Settings → Connected apps → Add custom connector
40
+
41
+ Sign in with the same Google account when prompted. Then ask the AI to list your files.
31
42
 
32
43
  ## Commands
33
44
 
34
- Run `dlink` to start the interactive agent. Once running, you can type these in the console:
45
+ Run `dlink` to start the interactive agent. Once running, type these in the console:
35
46
 
36
47
  | Command | What it does |
37
48
  |---------|-------------|
38
- | `signin` | Sign in to DeviceLink |
49
+ | `signin` | Sign in to DeviceLink (opens browser) |
39
50
  | `signout` | Sign out on this device |
40
51
  | `status` | Show connection status |
41
52
  | `stop` | Disconnect and exit |
@@ -45,7 +56,7 @@ Run `dlink` to start the interactive agent. Once running, you can type these in
45
56
  1. **Run the agent** from the folder you want to share.
46
57
  2. **Sign in** with Google when the browser opens.
47
58
  3. **Approve your device** when prompted in the terminal.
48
- 4. **Stay connected** so tool calls from ChatGPT can reach your machine.
59
+ 4. **Connect an AI** using the MCP endpoint above.
49
60
  5. **Stop anytime** by closing the agent. All access stops instantly.
50
61
 
51
62
  ## Security and privacy
@@ -57,9 +68,34 @@ Run `dlink` to start the interactive agent. Once running, you can type these in
57
68
  - Credentials are stored encrypted on your machine.
58
69
  - Access tokens are short-lived and refreshed automatically.
59
70
 
71
+ ## Anonymous usage data
72
+
73
+ The CLI reports anonymous usage data so we can see where setup breaks. It is on
74
+ by default. To turn it off:
75
+
76
+ ```bash
77
+ export DLINK_TELEMETRY=0 # or the cross-tool standard: DO_NOT_TRACK=1
78
+ ```
79
+
80
+ **What is sent:** a random install id (a UUID generated on first run and stored
81
+ in your config directory as `telemetry.json`), the CLI version, Node major
82
+ version, OS platform, OS major version, CPU architecture, and lifecycle events
83
+ - the agent started, config loaded, sign-in requested/completed, socket
84
+ connected/disconnected, session ready, the *name* of any tool invoked
85
+ (`fs_read`, `fs_list`, ...), and exit or crash reasons.
86
+
87
+ **What is never sent:** file names, file contents, directory paths, tool
88
+ arguments, tool results, your hostname, username, email address, machine id, or
89
+ anything about the folders you share. Your IP address is not recorded either -
90
+ events are sent with geolocation disabled and the IP field suppressed.
91
+
92
+ The install id is random and is not derived from your hardware, so it cannot be
93
+ linked back to your machine. Delete `telemetry.json` at any time to reset it.
94
+
60
95
  ## Links
61
96
 
62
97
  - Website: [devicelink.ai](https://devicelink.ai)
98
+ - Documentation: [devicelink.ai/docs](https://devicelink.ai/docs)
63
99
  - Support: [devicelink.ai/support](https://devicelink.ai/support)
64
100
 
65
101
  ## License