@deskwink/cli 0.0.0-stage → 0.1.0

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
@@ -1,3 +1,53 @@
1
- # Temporary Holding Version
1
+ # DeskWink CLI
2
2
 
3
- This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
3
+ DeskWink lets the AI you already use (Claude, ChatGPT and other apps that support remote MCP connectors) work with folders on your own Windows PC or Mac. You choose the folders, and every change waits for your approval.
4
+
5
+ This package is the small program that runs on your computer. It connects out to DeskWink, so your computer needs no open ports.
6
+
7
+ ## Requirements
8
+
9
+ - Windows 10/11 or macOS
10
+ - Node.js 22 or newer
11
+
12
+ ## Get started
13
+
14
+ ```bash
15
+ npm install -g @deskwink/cli
16
+ deskwink launch
17
+ ```
18
+
19
+ The first `deskwink launch` shows a pairing code and opens `app.deskwink.com` in your browser. Sign in and confirm that the code matches. DeskWink then asks which folder to share (the default is `~/DeskWink`) and keeps running in the background.
20
+
21
+ To connect your AI, add `https://mcp.deskwink.com/mcp` as a custom connector in your AI app, then sign in to DeskWink and allow it. Menu names differ between apps and plans; see [deskwink.com/docs](https://deskwink.com/docs).
22
+
23
+ Coding agents such as Claude Code or Codex can install DeskWink for you: point them at [deskwink.com/install.md](https://deskwink.com/install.md).
24
+
25
+ ## Commands
26
+
27
+ | Command | What it does |
28
+ | --- | --- |
29
+ | `deskwink launch` | Pair (first time), then start DeskWink in the background |
30
+ | `deskwink status` | Show the connection, computer, shared folders and the MCP URL |
31
+ | `deskwink stop` | Disconnect now; your AI can no longer reach this computer |
32
+ | `deskwink folders list \| add <path> \| remove <name>` | Manage shared folders (adding needs you at the keyboard) |
33
+ | `deskwink restore <execution-id>` | Undo a change DeskWink applied |
34
+ | `deskwink logs` | Show the local log (metadata only, never file contents) |
35
+ | `deskwink doctor` | Check Node, network, clock, credentials and folder access |
36
+ | `deskwink logout` | Remove this computer from DeskWink and delete its key |
37
+
38
+ Run `deskwink help` for every option.
39
+
40
+ ## How it keeps you in control
41
+
42
+ - Your AI can only see the folders you add on this computer. System folders, SSH keys, `.env` files and similar secrets are always off limits.
43
+ - Each file change is staged first. You review the exact change in the DeskWink console and approve it before anything is written, and the previous version is kept for 7 days.
44
+ - Giving DeskWink more access, such as a new folder, can only be done here, in your own terminal. The cloud can only take access away.
45
+ - DeskWink stores your device key in Windows DPAPI or the macOS Keychain. File contents never leave your computer except in answers to your AI.
46
+
47
+ ## Links
48
+
49
+ - Website and docs: [deskwink.com](https://deskwink.com)
50
+ - Privacy: [deskwink.com/legal/privacy](https://deskwink.com/legal/privacy) · Terms: [deskwink.com/legal/terms](https://deskwink.com/legal/terms)
51
+ - Security reports: security@deskwink.com
52
+
53
+ DeskWink is operated by Viva Essence Ltd (England and Wales, company number 16065477). This package is proprietary software, provided under the DeskWink Terms of Service. It bundles open-source components listed in `dist/THIRD_PARTY_NOTICES.txt`.
@@ -0,0 +1,59 @@
1
+ DeskWink CLI 0.1.0 bundles the following third-party packages.
2
+
3
+ diff@9.0.0 (BSD-3-Clause)
4
+
5
+ BSD 3-Clause License
6
+
7
+ Copyright (c) 2009-2015, Kevin Decker <kpdecker@gmail.com>
8
+ All rights reserved.
9
+
10
+ Redistribution and use in source and binary forms, with or without
11
+ modification, are permitted provided that the following conditions are met:
12
+
13
+ 1. Redistributions of source code must retain the above copyright notice, this
14
+ list of conditions and the following disclaimer.
15
+
16
+ 2. Redistributions in binary form must reproduce the above copyright notice,
17
+ this list of conditions and the following disclaimer in the documentation
18
+ and/or other materials provided with the distribution.
19
+
20
+ 3. Neither the name of the copyright holder nor the names of its
21
+ contributors may be used to endorse or promote products derived from
22
+ this software without specific prior written permission.
23
+
24
+ THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
25
+ AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26
+ IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
27
+ DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
28
+ FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
29
+ DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
30
+ SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
31
+ CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
32
+ OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
33
+ OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
34
+
35
+ ------------------------------------------------------------------------
36
+
37
+ zod@4.6.7 (MIT)
38
+
39
+ MIT License
40
+
41
+ Copyright (c) 2025 Colin McDonnell
42
+
43
+ Permission is hereby granted, free of charge, to any person obtaining a copy
44
+ of this software and associated documentation files (the "Software"), to deal
45
+ in the Software without restriction, including without limitation the rights
46
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
47
+ copies of the Software, and to permit persons to whom the Software is
48
+ furnished to do so, subject to the following conditions:
49
+
50
+ The above copyright notice and this permission notice shall be included in all
51
+ copies or substantial portions of the Software.
52
+
53
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
54
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
55
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
56
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
57
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
58
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
59
+ SOFTWARE.