Getting started - Docs

Before you start

A Windows 10 or 11 PC, or a Mac running macOS 13 or later. Linux is not supported at the moment.
Node.js 22 or newer. Check with node --version.
A DeskWink account. You sign in with Google or with an email link when you pair your computer.
An AI app that lets you add a custom connector (a remote MCP server). See Connect your AI.

Prefer to let your coding agent do the installation? See Install with your AI agent. You still confirm the pairing yourself.

1. Install the CLI

npm install -g @deskwink/cli

Then check that it works:

deskwink version

If your terminal does not find the command, or reports an error during install, see Troubleshooting. On Windows, PowerShell can block npm’s script wrapper; the fix is a one-word change and does not need any system setting.

2. Pair this computer and start DeskWink

deskwink launch

The first time, deskwink launch:

Checks your Node.js version and that its own files can be written.
Prints a pairing link and a short code, and opens the link in your browser unless you used --no-browser. The code is valid for 5 minutes.
Waits while you sign in in the browser and confirm the code. Pairing must be done by you; there is no way to do it for you.
Creates a key for this computer on this computer. DeskWink keeps only the public half. The private half stays in your operating system’s protected storage.
Asks which folder to share if none is set up yet. The suggested folder is ~/DeskWink, created if it does not exist.
Starts DeskWink in the background and waits until it is connected.

DeskWink keeps running after you close the terminal. It does not start again by itself after a restart or logout: run deskwink launch again whenever you want it on. You will not need to pair again.

Check the state at any time:

deskwink status

3. Choose what your AI can see

Only folders you add are visible to your AI. Folders are added on this computer, from this command line, and nowhere else.

deskwink folders list

deskwink folders add ~/Documents/notes

By default a folder is read-only: your AI can list, read and search it. Add --write if your AI should also be able to propose changes. Every change still waits for your approval in the console.

deskwink folders add ~/Documents/notes --write

Good to know

Some files stay blocked even inside a shared folder, for example SSH keys, .env files, private keys and browser profiles. You can read why in the security model. Your home folder can only be added with an extra flag (--allow-broad) in an interactive terminal, and whole drives and system folders cannot be added at all. We recommend sharing a smaller folder.

4. Connect your AI app

Add this address as a custom connector in your AI app:

https://mcp.deskwink.com/mcp

Step-by-step pages: Claude, ChatGPT, and other remote MCP apps.

5. Make your first request

In a new conversation with the connector enabled, try:

“Which computers do I have connected to DeskWink?”
“List the files in my DeskWink folder.”
“Read the file notes.md and give me a three-line summary.”

When your AI proposes a change to a file, DeskWink shows you the exact change in the console. Nothing is written until you approve it. Before it is applied, DeskWink saves a copy of the original on your computer.

Day to day

deskwink stop stops DeskWink on this computer immediately.
deskwink launch starts it again. Running it when DeskWink is already running only prints the status.
deskwink restore <execution-id> puts back a file DeskWink changed, from the local backup.
The CLI reference lists every command.

Remove DeskWink

Run deskwink logout. It removes this computer from your account, deletes its key and stops DeskWink.
Run npm uninstall -g @deskwink/cli to remove the program.
Remove the DeskWink connector from your AI app, and revoke the connection in the DeskWink console if you no longer use it.
If you want your account deleted, ask from the console or write to [email protected]. See the Privacy Policy for what is kept and for how long.