@devicelink/dlink 0.3.2 → 0.3.5

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 +29 -16
  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
 
@@ -16,42 +16,54 @@ Requires Node.js 20+.
16
16
 
17
17
  Sign in at [devicelink.ai](https://devicelink.ai) with Google. A workspace is created for you automatically.
18
18
 
19
- ### 2. Run the agent
19
+ ### 2. Install and run the agent
20
+
21
+ Open a terminal in the folder you want to share, then:
20
22
 
21
23
  ```bash
24
+ npm install -g @devicelink/dlink
22
25
  dlink
23
26
  ```
24
27
 
25
- The agent will open your browser to sign in with the same Google account. Once authenticated, your device is linked to your workspace. Choose a folder to share when prompted.
28
+ Type `signin` in the agent console and sign in with the same Google account.
29
+
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
+ ```
26
37
 
27
- ### 3. Connect ChatGPT
38
+ - **Claude** - Settings → Integrations → Add connector
39
+ - **ChatGPT** - Settings → Connected apps → Add custom connector
28
40
 
29
- Add DeviceLink as an MCP integration in ChatGPT (chatgpt.com → Settings → Connected apps). Sign in with the same Google account. Ask ChatGPT to list your files using DeviceLink - you're all set.
41
+ Sign in with the same Google account when prompted. Then ask the AI to list your files.
30
42
 
31
43
  ## Commands
32
44
 
33
- Run `dlink` to start the interactive agent. Once running, you can use these commands in the console:
45
+ Run `dlink` to start the interactive agent. Once running, type these in the console:
34
46
 
35
47
  | Command | What it does |
36
48
  |---------|-------------|
37
- | `signin` | Sign in to DeviceLink |
49
+ | `signin` | Sign in to DeviceLink (opens browser) |
38
50
  | `signout` | Sign out on this device |
51
+ | `status` | Show connection status |
39
52
  | `stop` | Disconnect and exit |
40
53
 
41
54
  ## How it works
42
55
 
43
- 1. **Sign in** - the agent opens your browser for Google sign-in.
44
- 2. **Approve your device** - confirm on the web UI that this device can connect.
45
- 3. **Share folders** - choose which directories the AI can access.
46
- 4. **Stay connected** - the agent maintains a secure WebSocket connection so tool calls reach your machine.
47
- 5. **Use your AI** - ChatGPT can list, read, search, and grep files in your shared folders.
48
- 6. **Stop anytime** - close the agent and all access stops instantly.
56
+ 1. **Run the agent** from the folder you want to share.
57
+ 2. **Sign in** with Google when the browser opens.
58
+ 3. **Approve your device** when prompted in the terminal.
59
+ 4. **Connect an AI** using the MCP endpoint above.
60
+ 5. **Stop anytime** by closing the agent. All access stops instantly.
49
61
 
50
- ## Security & privacy
62
+ ## Security and privacy
51
63
 
52
- - Files are streamed in real-time - nothing is stored on our servers.
64
+ - Files are streamed in real-time. Nothing is stored on our servers.
53
65
  - Each device is verified with Ed25519 cryptographic signatures.
54
- - Shared folders are sandboxed - the AI cannot access anything outside what you shared.
66
+ - Shared folders are sandboxed. The AI cannot access anything outside the shared directory.
55
67
  - Path traversal and symlink escapes are blocked.
56
68
  - Credentials are stored encrypted on your machine.
57
69
  - Access tokens are short-lived and refreshed automatically.
@@ -59,6 +71,7 @@ Run `dlink` to start the interactive agent. Once running, you can use these comm
59
71
  ## Links
60
72
 
61
73
  - Website: [devicelink.ai](https://devicelink.ai)
74
+ - Documentation: [devicelink.ai/docs](https://devicelink.ai/docs)
62
75
  - Support: [devicelink.ai/support](https://devicelink.ai/support)
63
76
 
64
77
  ## License