Guide
Install the connector
Get the connector onto your computer with npx or a signed download, and check that it runs.
- Applies to
- Windows, macOS and Linux; connector 0.2.0
- Time
- About 5 minutes
- What it changes
- Adds a program to your computer. It writes no other files and starts no service.
- Last reviewed
- , by Product documentation
Before you begin
What to know before you start
- The connector is a program that runs on your computer and opens a connection to InstaWormhole. Install only the copy from npm or from instawormhole.com.
Steps
Step 1. Choose how to run it.
With npx you do not install anything yourself: npx downloads the connector the first time you run it.
Terminal npx @instawormhole/connector versionOr install it once and keep it on your path.
Terminal npm install --global @instawormhole/connectorYou should see: The terminal prints the connector name and its version.
To check: The version is 0.2.0 or later.
Step 2. Or download the program for your system.
The release manifest lists every file with its SHA-256 checksum. Download the manifest and the file for your system, then compare the checksum.
Files in release 0.2.0 System File Windows x64 instawormhole-connector-0.2.0-win32-x64.exe macOS, Apple silicon instawormhole-connector-0.2.0-darwin-arm64 macOS, Intel instawormhole-connector-0.2.0-darwin-x64 Linux x64 instawormhole-connector-0.2.0-linux-x64 Linux arm64 instawormhole-connector-0.2.0-linux-arm64 The manifest is at https://instawormhole.com/downloads/connector/latest/manifest.json and its signature is the same address with .sig on the end. Files are at https://instawormhole.com/downloads/connector/0.2.0/ followed by the file name.
Linux or macOS terminal sha256sum instawormhole-connector-0.2.0-linux-x64On macOS use shasum -a 256 instead of sha256sum. In Windows PowerShell use Get-FileHash.
Compare the result with the sha256 value for that file in the manifest. Do not run a file whose checksum differs.
You should see: The checksum you calculated matches the manifest.
Step 3. On Linux and macOS, allow the file to run.
Terminal chmod +x ./instawormhole-connector-0.2.0-linux-x64You should see: Running the file with the version command prints its name and version.
Step 4. On macOS, confirm the first run if macOS warns about the downloaded file.
The program is not signed with an Apple Developer ID yet, so macOS shows a message that it cannot check the program for malicious software. Open System Settings, then Privacy & Security, scroll to the message about instawormhole-connector and choose Open Anyway.
Or remove the quarantine mark in Terminal:
Terminal xattr -d com.apple.quarantine ./instawormhole-connectorCopies installed with npm are not quarantined, so they do not show this message.
You should see: The program starts without the warning.
You are done when
- The version command prints the connector name and version 0.2.0 or later.
What to do next
If something goes wrong
- npx reports an error about the Node.js version.
- The connector needs Node.js 20 or later for npx. Check with node --version and update Node.js, or download the program instead.
- The checksum differs from the manifest.
- The file's checksum does not match the manifest. Delete it and download it again from instawormhole.com. If it still does not match, do not run it and report it from the contact page.
Undo or clean up
- To remove it, run the uninstall command described in Update, sign out and uninstall the connector.
Related
This page is part of Connect a local app. Still stuck? Contact support.