Zynk CLI

Setting up the Zynk CLI

Install Zynk, set up your account, and send your first transfer from the terminal.

Installation

Run the installer in a terminal. It detects your operating system and CPU, downloads the matching binary, and starts guided setup.

macOS, Linux, or FreeBSD

$ curl -fsSL https://zynk.it/install.sh | bash

Windows PowerShell

PS> irm https://zynk.it/install.ps1 | iex

Where it installs

  • macOS, Linux, and FreeBSD use ~/.local/bin unless ZYNK_INSTALL_DIR is set.
  • Windows uses %USERPROFILE%\.zynk\bin and updates your user PATH.
  • For unattended installation, set ZYNK_NO_SETUP=1 to install only the binary, then run zynk install later to finish setup.

Installation check

Check the installed CLI

$ zynk --versionzynk <version>

Your installed version appears in place of <version>. If the command is not found, open a new terminal so it picks up the PATH change.

Signing in

If setup has already signed you in, continue to your first transfer. Otherwise, sign in with your account email address or an existing account phone number.

Sign in to this device

$ zynk login [email protected]

New accounts use email. A phone number already on an existing account also works, with its country code and leading +. Follow any verification prompts. Switching from an account already signed in on this device asks for confirmation and stops its active transfers.

Sending a file or folder

zynk send takes a destination first, then one or more paths. The path can be a file, a folder, or many paths from stdin.

For a real first send, use another Zynk account's email address or phone number, or a second device that is already set up under your account. A single configured machine cannot receive its own first transfer unless another target exists.

Send to a person

$ zynk send [email protected] ~/Projects/site-backupSuccessfully requested Folder send to [email protected]

Contact names work too, but an email address or phone number is the explicit target. If you only know someone's username, add them first with zynk set-contact dana Dana, then send to the contact name. This line means Zynk accepted the send request locally; the recipient still needs to come online and accept before files are saved there.

Send to your own device

$ zynk send my:iphone ~/Videos$ zynk send my:"Mac Home" ~/Videos

Prefix any of your own device names with my: to target that device. Quote the name when it contains spaces. Run zynk devices to see the names registered under your account.

If your device is missing

  • If zynk devices is empty or only shows this machine, set up Zynk on the other device with the same account address.
  • If the expected device is missing, run zynk about on both machines and confirm they use the same account.
  • Use an email address or phone number for another person, and my:devicename only for a device under your own account.

Receiving a file

Incoming transfers wait in your inbox until you accept them. Nothing is saved to disk until you choose it.

Accept one transfer

$ zynk pendingID    NAME           SIZE      STATE      SENDER0     site-backup    1.4 GB    pending    Alice$ zynk pending --contact NobodyNo pending transfers.$ zynk accept 0 ~/DownloadsAccepting file transfer from Alice: site-backup to ~/DownloadsPlease use showprogress|sp to see the file's progress

The 0 is the pending row ID. The final argument is the folder where Zynk saves the accepted transfer.

The prompt and full-screen interface

Open Activity when you want to browse conversations, select files, and review transfers in a full-screen workspace. Use zynk repl for the command prompt.

Press Ctrl+G to switch between Activity and the prompt. Plain zynk opens your saved startup interface. See Activity TUI for navigation and sending files.

Open Activity

$ zynk activity

Updating the CLI

Install the latest available update

$ zynk update

Review the confirmation before proceeding. zynk update --dry-run previews the operation; zynk update --yes skips confirmation. Run zynk --version afterward to check the installed version.