This page is generated from the program and its code when the documentation is built. It is not edited by hand.

Command line

This page is generated from the easysync program: its command definitions and the text of its --help for every command. It cannot differ from the program that was built from the same commit (f401b20140c8).

Secrets are never arguments. A pairing code or a relay access token is read from a prompt or from standard input, so that it appears in no process list and no shell history.

Options of every command #

These options are accepted by every command. Those about the engine have an effect only on a command that starts an engine of its own (the daemon, or the one-off engine of a command that finds no daemon).

Option	Default	Meaning
`--listen <ADDR>`		QUIC listening address; default 0.0.0.0 on the preferred port (47017), or any free port
`--keystore <KEYSTORE>`		Where the identity and state keys live; overrides EASYSYNC_KEY_STORE. Default: the OS key store. There is no probing and no fallback Values: `file`, `os`.
`--no-discovery`	`false`	Do not advertise or browse on the LAN (mDNS)
`--no-clipboard`	`false`	Do not host an OS clipboard backend (the daemon watches and writes the clipboard of its desktop session by default; `config.toml`: `clipboard = false`)
`--incoming-dir <DIR>`		Directory for accepted files (default: <state dir>/incoming)
`--relay-ca <FILE>`		PEM file with a CA certificate to trust for relay connections, besides the web PKI roots (a self-hosted relay with a private CA). May be given more than once. It only applies to an engine this command starts itself (the daemon, or an ephemeral engine), not to a running daemon May be given more than once.

easysync #

End-to-end encrypted sync of clipboard text and files between your own devices

Usage: easysync [OPTIONS] <COMMAND>

Command	What it does
`easysync status`	Show this device and the engine
`easysync config`	Settings of this device
`easysync pair`	Invite another device: print a pairing code (and a QR code for a phone to scan) and confirm the SAS
`easysync join`	Join the pairing of another device; the pairing code is read from a prompt or stdin
`easysync pairing`	Pairings in progress
`easysync events`	Print the events of the engine, one line each, until interrupted. Never prints clipboard text, a pairing code, an access token or a confirmation code
`easysync peer`	Paired devices
`easysync send`	Send a file to a peer
`easysync transfer`	Transfers
`easysync clip`	Clipboard text
`easysync relay`	Relays
`easysync reset`	Erase the state of this device (offline: it never starts an engine). Stop a daemon or an app that hosts the engine first
`easysync daemon`	Run the engine in the foreground and serve the local IPC

The full text of --help:

End-to-end encrypted sync of clipboard text and files between your own devices

Usage: easysync [OPTIONS] <COMMAND>

Commands:
  status    Show this device and the engine
  config    Settings of this device
  pair      Invite another device: print a pairing code (and a QR code for a phone to scan) and confirm the SAS
  join      Join the pairing of another device; the pairing code is read from a prompt or stdin
  pairing   Pairings in progress
  events    Print the events of the engine, one line each, until interrupted. Never prints clipboard text, a pairing code, an access token or a confirmation code
  peer      Paired devices
  send      Send a file to a peer
  transfer  Transfers
  clip      Clipboard text
  relay     Relays
  reset     Erase the state of this device (offline: it never starts an engine). Stop a daemon or an app that hosts the engine first
  daemon    Run the engine in the foreground and serve the local IPC
  help      Print this message or the help of the given subcommand(s)

Options:
      --listen <ADDR>
          QUIC listening address; default 0.0.0.0 on the preferred port (47017), or any free port

      --keystore <KEYSTORE>
          Where the identity and state keys live; overrides EASYSYNC_KEY_STORE. Default: the OS key store. There is no probing and no fallback

          Possible values:
          - file: The headless key file keys.cbor (mode 0600)
          - os:   Credential Manager, Keychain or the Secret Service

      --no-discovery
          Do not advertise or browse on the LAN (mDNS)

      --no-clipboard
          Do not host an OS clipboard backend (the daemon watches and writes the clipboard of its desktop session by default; `config.toml`: `clipboard = false`)

      --incoming-dir <DIR>
          Directory for accepted files (default: <state dir>/incoming)

      --relay-ca <FILE>
          PEM file with a CA certificate to trust for relay connections, besides the web PKI roots (a self-hosted relay with a private CA). May be given more than once. It only applies to an engine this command starts itself (the daemon, or an ephemeral engine), not to a running daemon

  -h, --help
          Print help (see a summary with '-h')

  -V, --version
          Print version

easysync status #

Show this device and the engine

Usage: easysync status [OPTIONS]

The full text of --help:

Show this device and the engine

Usage: easysync status [OPTIONS]

Options:
      --listen <ADDR>
          QUIC listening address; default 0.0.0.0 on the preferred port (47017), or any free port

      --keystore <KEYSTORE>
          Where the identity and state keys live; overrides EASYSYNC_KEY_STORE. Default: the OS key store. There is no probing and no fallback

          Possible values:
          - file: The headless key file keys.cbor (mode 0600)
          - os:   Credential Manager, Keychain or the Secret Service

      --no-discovery
          Do not advertise or browse on the LAN (mDNS)

      --no-clipboard
          Do not host an OS clipboard backend (the daemon watches and writes the clipboard of its desktop session by default; `config.toml`: `clipboard = false`)

      --incoming-dir <DIR>
          Directory for accepted files (default: <state dir>/incoming)

      --relay-ca <FILE>
          PEM file with a CA certificate to trust for relay connections, besides the web PKI roots (a self-hosted relay with a private CA). May be given more than once. It only applies to an engine this command starts itself (the daemon, or an ephemeral engine), not to a running daemon

  -h, --help
          Print help (see a summary with '-h')

easysync config #

Settings of this device

Usage: easysync config [OPTIONS] <COMMAND>

Command	What it does
`easysync config name`	Set the display name other devices see
`easysync config get`	Show the global settings of this device with their source, or one setting
`easysync config set`	Change a global setting: on or off for a switch, a size (bytes with an optional K, M or G suffix) for a limit, an absolute path for incoming_dir
`easysync config reset`	Return a global setting to its default

The full text of --help:

Settings of this device

Usage: easysync config [OPTIONS] <COMMAND>

Commands:
  name   Set the display name other devices see
  get    Show the global settings of this device with their source, or one setting
  set    Change a global setting: on or off for a switch, a size (bytes with an optional K, M or G suffix) for a limit, an absolute path for incoming_dir
  reset  Return a global setting to its default
  help   Print this message or the help of the given subcommand(s)

Options:
      --listen <ADDR>
          QUIC listening address; default 0.0.0.0 on the preferred port (47017), or any free port

      --keystore <KEYSTORE>
          Where the identity and state keys live; overrides EASYSYNC_KEY_STORE. Default: the OS key store. There is no probing and no fallback

          Possible values:
          - file: The headless key file keys.cbor (mode 0600)
          - os:   Credential Manager, Keychain or the Secret Service

      --no-discovery
          Do not advertise or browse on the LAN (mDNS)

      --no-clipboard
          Do not host an OS clipboard backend (the daemon watches and writes the clipboard of its desktop session by default; `config.toml`: `clipboard = false`)

      --incoming-dir <DIR>
          Directory for accepted files (default: <state dir>/incoming)

      --relay-ca <FILE>
          PEM file with a CA certificate to trust for relay connections, besides the web PKI roots (a self-hosted relay with a private CA). May be given more than once. It only applies to an engine this command starts itself (the daemon, or an ephemeral engine), not to a running daemon

  -h, --help
          Print help (see a summary with '-h')

easysync config name #

Set the display name other devices see

Usage: easysync config name [OPTIONS] <NAME>

Argument	Required	Meaning
`<NAME>`	yes

The full text of --help:

Set the display name other devices see

Usage: easysync config name [OPTIONS] <NAME>

Arguments:
  <NAME>


Options:
      --listen <ADDR>
          QUIC listening address; default 0.0.0.0 on the preferred port (47017), or any free port

      --keystore <KEYSTORE>
          Where the identity and state keys live; overrides EASYSYNC_KEY_STORE. Default: the OS key store. There is no probing and no fallback

          Possible values:
          - file: The headless key file keys.cbor (mode 0600)
          - os:   Credential Manager, Keychain or the Secret Service

      --no-discovery
          Do not advertise or browse on the LAN (mDNS)

      --no-clipboard
          Do not host an OS clipboard backend (the daemon watches and writes the clipboard of its desktop session by default; `config.toml`: `clipboard = false`)

      --incoming-dir <DIR>
          Directory for accepted files (default: <state dir>/incoming)

      --relay-ca <FILE>
          PEM file with a CA certificate to trust for relay connections, besides the web PKI roots (a self-hosted relay with a private CA). May be given more than once. It only applies to an engine this command starts itself (the daemon, or an ephemeral engine), not to a running daemon

  -h, --help
          Print help (see a summary with '-h')

easysync config get #

Show the global settings of this device with their source, or one setting

Usage: easysync config get [OPTIONS] [SETTING]

Argument	Required	Meaning
`<SETTING>`	no	clipboard_sync, max_clipboard_size, show_source_device, deliver_latest_on_reconnect, incoming_dir or min_free_space_margin

The full text of --help:

Show the global settings of this device with their source, or one setting

Usage: easysync config get [OPTIONS] [SETTING]

Arguments:
  [SETTING]
          clipboard_sync, max_clipboard_size, show_source_device, deliver_latest_on_reconnect, incoming_dir or min_free_space_margin

Options:
      --listen <ADDR>
          QUIC listening address; default 0.0.0.0 on the preferred port (47017), or any free port

      --keystore <KEYSTORE>
          Where the identity and state keys live; overrides EASYSYNC_KEY_STORE. Default: the OS key store. There is no probing and no fallback

          Possible values:
          - file: The headless key file keys.cbor (mode 0600)
          - os:   Credential Manager, Keychain or the Secret Service

      --no-discovery
          Do not advertise or browse on the LAN (mDNS)

      --no-clipboard
          Do not host an OS clipboard backend (the daemon watches and writes the clipboard of its desktop session by default; `config.toml`: `clipboard = false`)

      --incoming-dir <DIR>
          Directory for accepted files (default: <state dir>/incoming)

      --relay-ca <FILE>
          PEM file with a CA certificate to trust for relay connections, besides the web PKI roots (a self-hosted relay with a private CA). May be given more than once. It only applies to an engine this command starts itself (the daemon, or an ephemeral engine), not to a running daemon

  -h, --help
          Print help (see a summary with '-h')

easysync config set #

Change a global setting: on or off for a switch, a size (bytes with an optional K, M or G suffix) for a limit, an absolute path for incoming_dir

Usage: easysync config set [OPTIONS] <SETTING> <VALUE>

Argument	Required	Meaning
`<SETTING>`	yes
`<VALUE>`	yes

The full text of --help:

Change a global setting: on or off for a switch, a size (bytes with an optional K, M or G suffix) for a limit, an absolute path for incoming_dir

Usage: easysync config set [OPTIONS] <SETTING> <VALUE>

Arguments:
  <SETTING>


  <VALUE>


Options:
      --listen <ADDR>
          QUIC listening address; default 0.0.0.0 on the preferred port (47017), or any free port

      --keystore <KEYSTORE>
          Where the identity and state keys live; overrides EASYSYNC_KEY_STORE. Default: the OS key store. There is no probing and no fallback

          Possible values:
          - file: The headless key file keys.cbor (mode 0600)
          - os:   Credential Manager, Keychain or the Secret Service

      --no-discovery
          Do not advertise or browse on the LAN (mDNS)

      --no-clipboard
          Do not host an OS clipboard backend (the daemon watches and writes the clipboard of its desktop session by default; `config.toml`: `clipboard = false`)

      --incoming-dir <DIR>
          Directory for accepted files (default: <state dir>/incoming)

      --relay-ca <FILE>
          PEM file with a CA certificate to trust for relay connections, besides the web PKI roots (a self-hosted relay with a private CA). May be given more than once. It only applies to an engine this command starts itself (the daemon, or an ephemeral engine), not to a running daemon

  -h, --help
          Print help (see a summary with '-h')

easysync config reset #

Return a global setting to its default

Usage: easysync config reset [OPTIONS] <SETTING>

Argument	Required	Meaning
`<SETTING>`	yes

The full text of --help:

Return a global setting to its default

Usage: easysync config reset [OPTIONS] <SETTING>

Arguments:
  <SETTING>


Options:
      --listen <ADDR>
          QUIC listening address; default 0.0.0.0 on the preferred port (47017), or any free port

      --keystore <KEYSTORE>
          Where the identity and state keys live; overrides EASYSYNC_KEY_STORE. Default: the OS key store. There is no probing and no fallback

          Possible values:
          - file: The headless key file keys.cbor (mode 0600)
          - os:   Credential Manager, Keychain or the Secret Service

      --no-discovery
          Do not advertise or browse on the LAN (mDNS)

      --no-clipboard
          Do not host an OS clipboard backend (the daemon watches and writes the clipboard of its desktop session by default; `config.toml`: `clipboard = false`)

      --incoming-dir <DIR>
          Directory for accepted files (default: <state dir>/incoming)

      --relay-ca <FILE>
          PEM file with a CA certificate to trust for relay connections, besides the web PKI roots (a self-hosted relay with a private CA). May be given more than once. It only applies to an engine this command starts itself (the daemon, or an ephemeral engine), not to a running daemon

  -h, --help
          Print help (see a summary with '-h')

easysync pair #

Invite another device: print a pairing code (and a QR code for a phone to scan) and confirm the SAS

Usage: easysync pair [OPTIONS]

Option	Default	Meaning
`--ttl <TTL>`	`180`	Seconds the code stays valid (1-180)
`--no-relay`	`false`	Do not register the code at a relay, even if one is configured
`--no-qr`	`false`	Print the pairing code as text only, without the QR code (a terminal shows the QR code only where stdout is a terminal)

The full text of --help:

Invite another device: print a pairing code (and a QR code for a phone to scan) and confirm the SAS

Usage: easysync pair [OPTIONS]

Options:
      --listen <ADDR>
          QUIC listening address; default 0.0.0.0 on the preferred port (47017), or any free port

      --ttl <TTL>
          Seconds the code stays valid (1-180)

          [default: 180]

      --keystore <KEYSTORE>
          Where the identity and state keys live; overrides EASYSYNC_KEY_STORE. Default: the OS key store. There is no probing and no fallback

          Possible values:
          - file: The headless key file keys.cbor (mode 0600)
          - os:   Credential Manager, Keychain or the Secret Service

      --no-relay
          Do not register the code at a relay, even if one is configured

      --no-discovery
          Do not advertise or browse on the LAN (mDNS)

      --no-qr
          Print the pairing code as text only, without the QR code (a terminal shows the QR code only where stdout is a terminal)

      --no-clipboard
          Do not host an OS clipboard backend (the daemon watches and writes the clipboard of its desktop session by default; `config.toml`: `clipboard = false`)

      --incoming-dir <DIR>
          Directory for accepted files (default: <state dir>/incoming)

      --relay-ca <FILE>
          PEM file with a CA certificate to trust for relay connections, besides the web PKI roots (a self-hosted relay with a private CA). May be given more than once. It only applies to an engine this command starts itself (the daemon, or an ephemeral engine), not to a running daemon

  -h, --help
          Print help (see a summary with '-h')

easysync join #

Join the pairing of another device; the pairing code is read from a prompt or stdin

Usage: easysync join [OPTIONS]

The full text of --help:

Join the pairing of another device; the pairing code is read from a prompt or stdin

Usage: easysync join [OPTIONS]

Options:
      --listen <ADDR>
          QUIC listening address; default 0.0.0.0 on the preferred port (47017), or any free port

      --keystore <KEYSTORE>
          Where the identity and state keys live; overrides EASYSYNC_KEY_STORE. Default: the OS key store. There is no probing and no fallback

          Possible values:
          - file: The headless key file keys.cbor (mode 0600)
          - os:   Credential Manager, Keychain or the Secret Service

      --no-discovery
          Do not advertise or browse on the LAN (mDNS)

      --no-clipboard
          Do not host an OS clipboard backend (the daemon watches and writes the clipboard of its desktop session by default; `config.toml`: `clipboard = false`)

      --incoming-dir <DIR>
          Directory for accepted files (default: <state dir>/incoming)

      --relay-ca <FILE>
          PEM file with a CA certificate to trust for relay connections, besides the web PKI roots (a self-hosted relay with a private CA). May be given more than once. It only applies to an engine this command starts itself (the daemon, or an ephemeral engine), not to a running daemon

  -h, --help
          Print help (see a summary with '-h')

easysync pairing #

Pairings in progress

Usage: easysync pairing [OPTIONS] <COMMAND>

Command	What it does
`easysync pairing list`	List the pairings in progress (the pairing code and the confirmation code are not shown)

The full text of --help:

Pairings in progress

Usage: easysync pairing [OPTIONS] <COMMAND>

Commands:
  list  List the pairings in progress (the pairing code and the confirmation code are not shown)
  help  Print this message or the help of the given subcommand(s)

Options:
      --listen <ADDR>
          QUIC listening address; default 0.0.0.0 on the preferred port (47017), or any free port

      --keystore <KEYSTORE>
          Where the identity and state keys live; overrides EASYSYNC_KEY_STORE. Default: the OS key store. There is no probing and no fallback

          Possible values:
          - file: The headless key file keys.cbor (mode 0600)
          - os:   Credential Manager, Keychain or the Secret Service

      --no-discovery
          Do not advertise or browse on the LAN (mDNS)

      --no-clipboard
          Do not host an OS clipboard backend (the daemon watches and writes the clipboard of its desktop session by default; `config.toml`: `clipboard = false`)

      --incoming-dir <DIR>
          Directory for accepted files (default: <state dir>/incoming)

      --relay-ca <FILE>
          PEM file with a CA certificate to trust for relay connections, besides the web PKI roots (a self-hosted relay with a private CA). May be given more than once. It only applies to an engine this command starts itself (the daemon, or an ephemeral engine), not to a running daemon

  -h, --help
          Print help (see a summary with '-h')

easysync pairing list #

List the pairings in progress (the pairing code and the confirmation code are not shown)

Usage: easysync pairing list [OPTIONS]

The full text of --help:

List the pairings in progress (the pairing code and the confirmation code are not shown)

Usage: easysync pairing list [OPTIONS]

Options:
      --listen <ADDR>
          QUIC listening address; default 0.0.0.0 on the preferred port (47017), or any free port

      --keystore <KEYSTORE>
          Where the identity and state keys live; overrides EASYSYNC_KEY_STORE. Default: the OS key store. There is no probing and no fallback

          Possible values:
          - file: The headless key file keys.cbor (mode 0600)
          - os:   Credential Manager, Keychain or the Secret Service

      --no-discovery
          Do not advertise or browse on the LAN (mDNS)

      --no-clipboard
          Do not host an OS clipboard backend (the daemon watches and writes the clipboard of its desktop session by default; `config.toml`: `clipboard = false`)

      --incoming-dir <DIR>
          Directory for accepted files (default: <state dir>/incoming)

      --relay-ca <FILE>
          PEM file with a CA certificate to trust for relay connections, besides the web PKI roots (a self-hosted relay with a private CA). May be given more than once. It only applies to an engine this command starts itself (the daemon, or an ephemeral engine), not to a running daemon

  -h, --help
          Print help (see a summary with '-h')

easysync events #

Print the events of the engine, one line each, until interrupted. Never prints clipboard text, a pairing code, an access token or a confirmation code

Usage: easysync events [OPTIONS] [NAMES]...

Argument	Required	Meaning
`<NAMES>`	no	Only these events (peer.changed, pairing.sas, pairing.done, transfer.offer, transfer.state, transfer.progress, clipboard.received, pairing.state, relay.state, settings.changed, engine.condition, clipboard.sent); default: every event the engine offers

The full text of --help:

Print the events of the engine, one line each, until interrupted. Never prints clipboard text, a pairing code, an access token or a confirmation code

Usage: easysync events [OPTIONS] [NAMES]...

Arguments:
  [NAMES]...
          Only these events (peer.changed, pairing.sas, pairing.done, transfer.offer, transfer.state, transfer.progress, clipboard.received, pairing.state, relay.state, settings.changed, engine.condition, clipboard.sent); default: every event the engine offers

Options:
      --listen <ADDR>
          QUIC listening address; default 0.0.0.0 on the preferred port (47017), or any free port

      --keystore <KEYSTORE>
          Where the identity and state keys live; overrides EASYSYNC_KEY_STORE. Default: the OS key store. There is no probing and no fallback

          Possible values:
          - file: The headless key file keys.cbor (mode 0600)
          - os:   Credential Manager, Keychain or the Secret Service

      --no-discovery
          Do not advertise or browse on the LAN (mDNS)

      --no-clipboard
          Do not host an OS clipboard backend (the daemon watches and writes the clipboard of its desktop session by default; `config.toml`: `clipboard = false`)

      --incoming-dir <DIR>
          Directory for accepted files (default: <state dir>/incoming)

      --relay-ca <FILE>
          PEM file with a CA certificate to trust for relay connections, besides the web PKI roots (a self-hosted relay with a private CA). May be given more than once. It only applies to an engine this command starts itself (the daemon, or an ephemeral engine), not to a running daemon

  -h, --help
          Print help (see a summary with '-h')

easysync peer #

Paired devices

Usage: easysync peer [OPTIONS] <COMMAND>

Command	What it does
`easysync peer list`	List the paired devices
`easysync peer show`	Show one device
`easysync peer revoke`	Revoke trust in a device (local; the discovery secret is rotated)
`easysync peer policy`	Show or change the policy for a device
`easysync peer rename`	Set a local alias (empty text removes it)

The full text of --help:

Paired devices

Usage: easysync peer [OPTIONS] <COMMAND>

Commands:
  list    List the paired devices
  show    Show one device
  revoke  Revoke trust in a device (local; the discovery secret is rotated)
  policy  Show or change the policy for a device
  rename  Set a local alias (empty text removes it)
  help    Print this message or the help of the given subcommand(s)

Options:
      --listen <ADDR>
          QUIC listening address; default 0.0.0.0 on the preferred port (47017), or any free port

      --keystore <KEYSTORE>
          Where the identity and state keys live; overrides EASYSYNC_KEY_STORE. Default: the OS key store. There is no probing and no fallback

          Possible values:
          - file: The headless key file keys.cbor (mode 0600)
          - os:   Credential Manager, Keychain or the Secret Service

      --no-discovery
          Do not advertise or browse on the LAN (mDNS)

      --no-clipboard
          Do not host an OS clipboard backend (the daemon watches and writes the clipboard of its desktop session by default; `config.toml`: `clipboard = false`)

      --incoming-dir <DIR>
          Directory for accepted files (default: <state dir>/incoming)

      --relay-ca <FILE>
          PEM file with a CA certificate to trust for relay connections, besides the web PKI roots (a self-hosted relay with a private CA). May be given more than once. It only applies to an engine this command starts itself (the daemon, or an ephemeral engine), not to a running daemon

  -h, --help
          Print help (see a summary with '-h')

easysync peer list #

List the paired devices

Usage: easysync peer list [OPTIONS]

The full text of --help:

List the paired devices

Usage: easysync peer list [OPTIONS]

Options:
      --listen <ADDR>
          QUIC listening address; default 0.0.0.0 on the preferred port (47017), or any free port

      --keystore <KEYSTORE>
          Where the identity and state keys live; overrides EASYSYNC_KEY_STORE. Default: the OS key store. There is no probing and no fallback

          Possible values:
          - file: The headless key file keys.cbor (mode 0600)
          - os:   Credential Manager, Keychain or the Secret Service

      --no-discovery
          Do not advertise or browse on the LAN (mDNS)

      --no-clipboard
          Do not host an OS clipboard backend (the daemon watches and writes the clipboard of its desktop session by default; `config.toml`: `clipboard = false`)

      --incoming-dir <DIR>
          Directory for accepted files (default: <state dir>/incoming)

      --relay-ca <FILE>
          PEM file with a CA certificate to trust for relay connections, besides the web PKI roots (a self-hosted relay with a private CA). May be given more than once. It only applies to an engine this command starts itself (the daemon, or an ephemeral engine), not to a running daemon

  -h, --help
          Print help (see a summary with '-h')

easysync peer show #

Show one device

Usage: easysync peer show [OPTIONS] <PEER>

Argument	Required	Meaning
`<PEER>`	yes

The full text of --help:

Show one device

Usage: easysync peer show [OPTIONS] <PEER>

Arguments:
  <PEER>


Options:
      --listen <ADDR>
          QUIC listening address; default 0.0.0.0 on the preferred port (47017), or any free port

      --keystore <KEYSTORE>
          Where the identity and state keys live; overrides EASYSYNC_KEY_STORE. Default: the OS key store. There is no probing and no fallback

          Possible values:
          - file: The headless key file keys.cbor (mode 0600)
          - os:   Credential Manager, Keychain or the Secret Service

      --no-discovery
          Do not advertise or browse on the LAN (mDNS)

      --no-clipboard
          Do not host an OS clipboard backend (the daemon watches and writes the clipboard of its desktop session by default; `config.toml`: `clipboard = false`)

      --incoming-dir <DIR>
          Directory for accepted files (default: <state dir>/incoming)

      --relay-ca <FILE>
          PEM file with a CA certificate to trust for relay connections, besides the web PKI roots (a self-hosted relay with a private CA). May be given more than once. It only applies to an engine this command starts itself (the daemon, or an ephemeral engine), not to a running daemon

  -h, --help
          Print help (see a summary with '-h')

easysync peer revoke #

Revoke trust in a device (local; the discovery secret is rotated)

Usage: easysync peer revoke [OPTIONS] <PEER>

Argument	Required	Meaning
`<PEER>`	yes

The full text of --help:

Revoke trust in a device (local; the discovery secret is rotated)

Usage: easysync peer revoke [OPTIONS] <PEER>

Arguments:
  <PEER>


Options:
      --listen <ADDR>
          QUIC listening address; default 0.0.0.0 on the preferred port (47017), or any free port

      --keystore <KEYSTORE>
          Where the identity and state keys live; overrides EASYSYNC_KEY_STORE. Default: the OS key store. There is no probing and no fallback

          Possible values:
          - file: The headless key file keys.cbor (mode 0600)
          - os:   Credential Manager, Keychain or the Secret Service

      --no-discovery
          Do not advertise or browse on the LAN (mDNS)

      --no-clipboard
          Do not host an OS clipboard backend (the daemon watches and writes the clipboard of its desktop session by default; `config.toml`: `clipboard = false`)

      --incoming-dir <DIR>
          Directory for accepted files (default: <state dir>/incoming)

      --relay-ca <FILE>
          PEM file with a CA certificate to trust for relay connections, besides the web PKI roots (a self-hosted relay with a private CA). May be given more than once. It only applies to an engine this command starts itself (the daemon, or an ephemeral engine), not to a running daemon

  -h, --help
          Print help (see a summary with '-h')

easysync peer policy #

Show or change the policy for a device

Usage: easysync peer policy [OPTIONS] <PEER>

Option	Default	Meaning
`--accept <ACCEPT>`		What happens to an incoming file offer Values: `ask`, `auto`, `deny`.
`--max-file-size <SIZE>`		Largest accepted file: bytes with an optional K, M, G suffix, or "none"
`--max-incomplete <SIZE>`		Most partially received bytes held for this peer: like --max-file-size
`--max-pending <N>`		Most offers waiting for a decision
`--clip-send <CLIP_SEND>`		Send clipboard text to this peer Values: `on`, `off`.
`--clip-receive <CLIP_RECEIVE>`		Accept clipboard text from this peer Values: `on`, `off`.

Argument	Required	Meaning
`<PEER>`	yes

The full text of --help:

Show or change the policy for a device

Usage: easysync peer policy [OPTIONS] <PEER>

Arguments:
  <PEER>


Options:
      --accept <ACCEPT>
          What happens to an incoming file offer

          [possible values: ask, auto, deny]

      --listen <ADDR>
          QUIC listening address; default 0.0.0.0 on the preferred port (47017), or any free port

      --keystore <KEYSTORE>
          Where the identity and state keys live; overrides EASYSYNC_KEY_STORE. Default: the OS key store. There is no probing and no fallback

          Possible values:
          - file: The headless key file keys.cbor (mode 0600)
          - os:   Credential Manager, Keychain or the Secret Service

      --max-file-size <SIZE>
          Largest accepted file: bytes with an optional K, M, G suffix, or "none"

      --max-incomplete <SIZE>
          Most partially received bytes held for this peer: like --max-file-size

      --no-discovery
          Do not advertise or browse on the LAN (mDNS)

      --max-pending <N>
          Most offers waiting for a decision

      --no-clipboard
          Do not host an OS clipboard backend (the daemon watches and writes the clipboard of its desktop session by default; `config.toml`: `clipboard = false`)

      --clip-send <CLIP_SEND>
          Send clipboard text to this peer

          [possible values: on, off]

      --incoming-dir <DIR>
          Directory for accepted files (default: <state dir>/incoming)

      --clip-receive <CLIP_RECEIVE>
          Accept clipboard text from this peer

          [possible values: on, off]

      --relay-ca <FILE>
          PEM file with a CA certificate to trust for relay connections, besides the web PKI roots (a self-hosted relay with a private CA). May be given more than once. It only applies to an engine this command starts itself (the daemon, or an ephemeral engine), not to a running daemon

  -h, --help
          Print help (see a summary with '-h')

easysync peer rename #

Set a local alias (empty text removes it)

Usage: easysync peer rename [OPTIONS] <PEER> <ALIAS>

Argument	Required	Meaning
`<PEER>`	yes
`<ALIAS>`	yes

The full text of --help:

Set a local alias (empty text removes it)

Usage: easysync peer rename [OPTIONS] <PEER> <ALIAS>

Arguments:
  <PEER>


  <ALIAS>


Options:
      --listen <ADDR>
          QUIC listening address; default 0.0.0.0 on the preferred port (47017), or any free port

      --keystore <KEYSTORE>
          Where the identity and state keys live; overrides EASYSYNC_KEY_STORE. Default: the OS key store. There is no probing and no fallback

          Possible values:
          - file: The headless key file keys.cbor (mode 0600)
          - os:   Credential Manager, Keychain or the Secret Service

      --no-discovery
          Do not advertise or browse on the LAN (mDNS)

      --no-clipboard
          Do not host an OS clipboard backend (the daemon watches and writes the clipboard of its desktop session by default; `config.toml`: `clipboard = false`)

      --incoming-dir <DIR>
          Directory for accepted files (default: <state dir>/incoming)

      --relay-ca <FILE>
          PEM file with a CA certificate to trust for relay connections, besides the web PKI roots (a self-hosted relay with a private CA). May be given more than once. It only applies to an engine this command starts itself (the daemon, or an ephemeral engine), not to a running daemon

  -h, --help
          Print help (see a summary with '-h')

easysync send #

Send a file to a peer

Usage: easysync send [OPTIONS] <FILE> <PEER>

Option	Default	Meaning
`--wait`	`false`	Wait until the transfer finished (always so without a daemon)

Argument	Required	Meaning
`<FILE>`	yes
`<PEER>`	yes	Peer id, unique id prefix (6+ characters), display name or alias

The full text of --help:

Send a file to a peer

Usage: easysync send [OPTIONS] <FILE> <PEER>

Arguments:
  <FILE>


  <PEER>
          Peer id, unique id prefix (6+ characters), display name or alias

Options:
      --listen <ADDR>
          QUIC listening address; default 0.0.0.0 on the preferred port (47017), or any free port

      --wait
          Wait until the transfer finished (always so without a daemon)

      --keystore <KEYSTORE>
          Where the identity and state keys live; overrides EASYSYNC_KEY_STORE. Default: the OS key store. There is no probing and no fallback

          Possible values:
          - file: The headless key file keys.cbor (mode 0600)
          - os:   Credential Manager, Keychain or the Secret Service

      --no-discovery
          Do not advertise or browse on the LAN (mDNS)

      --no-clipboard
          Do not host an OS clipboard backend (the daemon watches and writes the clipboard of its desktop session by default; `config.toml`: `clipboard = false`)

      --incoming-dir <DIR>
          Directory for accepted files (default: <state dir>/incoming)

      --relay-ca <FILE>
          PEM file with a CA certificate to trust for relay connections, besides the web PKI roots (a self-hosted relay with a private CA). May be given more than once. It only applies to an engine this command starts itself (the daemon, or an ephemeral engine), not to a running daemon

  -h, --help
          Print help (see a summary with '-h')

easysync transfer #

Transfers

Usage: easysync transfer [OPTIONS] <COMMAND>

Command	What it does
`easysync transfer list`	List transfers (without finished ones unless --all)
`easysync transfer accept`	Accept an incoming offer
`easysync transfer cancel`	Cancel a transfer
`easysync transfer reject`	Reject an incoming offer (the same as cancel, which for an offer that waits for a decision is the user's rejection: the sender is told and the offer is not made again)
`easysync transfer pause`	Pause a running transfer
`easysync transfer resume`	Resume a paused transfer
`easysync transfer show`	Show one transfer

The full text of --help:

Transfers

Usage: easysync transfer [OPTIONS] <COMMAND>

Commands:
  list    List transfers (without finished ones unless --all)
  accept  Accept an incoming offer
  cancel  Cancel a transfer
  reject  Reject an incoming offer (the same as cancel, which for an offer that waits for a decision is the user's rejection: the sender is told and the offer is not made again)
  pause   Pause a running transfer
  resume  Resume a paused transfer
  show    Show one transfer
  help    Print this message or the help of the given subcommand(s)

Options:
      --listen <ADDR>
          QUIC listening address; default 0.0.0.0 on the preferred port (47017), or any free port

      --keystore <KEYSTORE>
          Where the identity and state keys live; overrides EASYSYNC_KEY_STORE. Default: the OS key store. There is no probing and no fallback

          Possible values:
          - file: The headless key file keys.cbor (mode 0600)
          - os:   Credential Manager, Keychain or the Secret Service

      --no-discovery
          Do not advertise or browse on the LAN (mDNS)

      --no-clipboard
          Do not host an OS clipboard backend (the daemon watches and writes the clipboard of its desktop session by default; `config.toml`: `clipboard = false`)

      --incoming-dir <DIR>
          Directory for accepted files (default: <state dir>/incoming)

      --relay-ca <FILE>
          PEM file with a CA certificate to trust for relay connections, besides the web PKI roots (a self-hosted relay with a private CA). May be given more than once. It only applies to an engine this command starts itself (the daemon, or an ephemeral engine), not to a running daemon

  -h, --help
          Print help (see a summary with '-h')

easysync transfer list #

List transfers (without finished ones unless --all)

Usage: easysync transfer list [OPTIONS]

Option	Default	Meaning
`--all`	`false`

The full text of --help:

List transfers (without finished ones unless --all)

Usage: easysync transfer list [OPTIONS]

Options:
      --all


      --listen <ADDR>
          QUIC listening address; default 0.0.0.0 on the preferred port (47017), or any free port

      --keystore <KEYSTORE>
          Where the identity and state keys live; overrides EASYSYNC_KEY_STORE. Default: the OS key store. There is no probing and no fallback

          Possible values:
          - file: The headless key file keys.cbor (mode 0600)
          - os:   Credential Manager, Keychain or the Secret Service

      --no-discovery
          Do not advertise or browse on the LAN (mDNS)

      --no-clipboard
          Do not host an OS clipboard backend (the daemon watches and writes the clipboard of its desktop session by default; `config.toml`: `clipboard = false`)

      --incoming-dir <DIR>
          Directory for accepted files (default: <state dir>/incoming)

      --relay-ca <FILE>
          PEM file with a CA certificate to trust for relay connections, besides the web PKI roots (a self-hosted relay with a private CA). May be given more than once. It only applies to an engine this command starts itself (the daemon, or an ephemeral engine), not to a running daemon

  -h, --help
          Print help (see a summary with '-h')

easysync transfer accept #

Accept an incoming offer

Usage: easysync transfer accept [OPTIONS] <ID>

Option	Default	Meaning
`--to <DIR>`		Directory to save into instead of the incoming directory

Argument	Required	Meaning
`<ID>`	yes	Transfer id: a unique prefix of 8+ hex characters

The full text of --help:

Accept an incoming offer

Usage: easysync transfer accept [OPTIONS] <ID>

Arguments:
  <ID>
          Transfer id: a unique prefix of 8+ hex characters

Options:
      --listen <ADDR>
          QUIC listening address; default 0.0.0.0 on the preferred port (47017), or any free port

      --to <DIR>
          Directory to save into instead of the incoming directory

      --keystore <KEYSTORE>
          Where the identity and state keys live; overrides EASYSYNC_KEY_STORE. Default: the OS key store. There is no probing and no fallback

          Possible values:
          - file: The headless key file keys.cbor (mode 0600)
          - os:   Credential Manager, Keychain or the Secret Service

      --no-discovery
          Do not advertise or browse on the LAN (mDNS)

      --no-clipboard
          Do not host an OS clipboard backend (the daemon watches and writes the clipboard of its desktop session by default; `config.toml`: `clipboard = false`)

      --incoming-dir <DIR>
          Directory for accepted files (default: <state dir>/incoming)

      --relay-ca <FILE>
          PEM file with a CA certificate to trust for relay connections, besides the web PKI roots (a self-hosted relay with a private CA). May be given more than once. It only applies to an engine this command starts itself (the daemon, or an ephemeral engine), not to a running daemon

  -h, --help
          Print help (see a summary with '-h')

easysync transfer cancel #

Cancel a transfer

Usage: easysync transfer cancel [OPTIONS] <ID>

Argument	Required	Meaning
`<ID>`	yes

The full text of --help:

Cancel a transfer

Usage: easysync transfer cancel [OPTIONS] <ID>

Arguments:
  <ID>


Options:
      --listen <ADDR>
          QUIC listening address; default 0.0.0.0 on the preferred port (47017), or any free port

      --keystore <KEYSTORE>
          Where the identity and state keys live; overrides EASYSYNC_KEY_STORE. Default: the OS key store. There is no probing and no fallback

          Possible values:
          - file: The headless key file keys.cbor (mode 0600)
          - os:   Credential Manager, Keychain or the Secret Service

      --no-discovery
          Do not advertise or browse on the LAN (mDNS)

      --no-clipboard
          Do not host an OS clipboard backend (the daemon watches and writes the clipboard of its desktop session by default; `config.toml`: `clipboard = false`)

      --incoming-dir <DIR>
          Directory for accepted files (default: <state dir>/incoming)

      --relay-ca <FILE>
          PEM file with a CA certificate to trust for relay connections, besides the web PKI roots (a self-hosted relay with a private CA). May be given more than once. It only applies to an engine this command starts itself (the daemon, or an ephemeral engine), not to a running daemon

  -h, --help
          Print help (see a summary with '-h')

easysync transfer reject #

Reject an incoming offer (the same as cancel, which for an offer that waits for a decision is the user's rejection: the sender is told and the offer is not made again)

Usage: easysync transfer reject [OPTIONS] <ID>

Argument	Required	Meaning
`<ID>`	yes

The full text of --help:

Reject an incoming offer (the same as cancel, which for an offer that waits for a decision is the user's rejection: the sender is told and the offer is not made again)

Usage: easysync transfer reject [OPTIONS] <ID>

Arguments:
  <ID>


Options:
      --listen <ADDR>
          QUIC listening address; default 0.0.0.0 on the preferred port (47017), or any free port

      --keystore <KEYSTORE>
          Where the identity and state keys live; overrides EASYSYNC_KEY_STORE. Default: the OS key store. There is no probing and no fallback

          Possible values:
          - file: The headless key file keys.cbor (mode 0600)
          - os:   Credential Manager, Keychain or the Secret Service

      --no-discovery
          Do not advertise or browse on the LAN (mDNS)

      --no-clipboard
          Do not host an OS clipboard backend (the daemon watches and writes the clipboard of its desktop session by default; `config.toml`: `clipboard = false`)

      --incoming-dir <DIR>
          Directory for accepted files (default: <state dir>/incoming)

      --relay-ca <FILE>
          PEM file with a CA certificate to trust for relay connections, besides the web PKI roots (a self-hosted relay with a private CA). May be given more than once. It only applies to an engine this command starts itself (the daemon, or an ephemeral engine), not to a running daemon

  -h, --help
          Print help (see a summary with '-h')

easysync transfer pause #

Pause a running transfer

Usage: easysync transfer pause [OPTIONS] <ID>

Argument	Required	Meaning
`<ID>`	yes

The full text of --help:

Pause a running transfer

Usage: easysync transfer pause [OPTIONS] <ID>

Arguments:
  <ID>


Options:
      --listen <ADDR>
          QUIC listening address; default 0.0.0.0 on the preferred port (47017), or any free port

      --keystore <KEYSTORE>
          Where the identity and state keys live; overrides EASYSYNC_KEY_STORE. Default: the OS key store. There is no probing and no fallback

          Possible values:
          - file: The headless key file keys.cbor (mode 0600)
          - os:   Credential Manager, Keychain or the Secret Service

      --no-discovery
          Do not advertise or browse on the LAN (mDNS)

      --no-clipboard
          Do not host an OS clipboard backend (the daemon watches and writes the clipboard of its desktop session by default; `config.toml`: `clipboard = false`)

      --incoming-dir <DIR>
          Directory for accepted files (default: <state dir>/incoming)

      --relay-ca <FILE>
          PEM file with a CA certificate to trust for relay connections, besides the web PKI roots (a self-hosted relay with a private CA). May be given more than once. It only applies to an engine this command starts itself (the daemon, or an ephemeral engine), not to a running daemon

  -h, --help
          Print help (see a summary with '-h')

easysync transfer resume #

Resume a paused transfer

Usage: easysync transfer resume [OPTIONS] <ID>

Argument	Required	Meaning
`<ID>`	yes

The full text of --help:

Resume a paused transfer

Usage: easysync transfer resume [OPTIONS] <ID>

Arguments:
  <ID>


Options:
      --listen <ADDR>
          QUIC listening address; default 0.0.0.0 on the preferred port (47017), or any free port

      --keystore <KEYSTORE>
          Where the identity and state keys live; overrides EASYSYNC_KEY_STORE. Default: the OS key store. There is no probing and no fallback

          Possible values:
          - file: The headless key file keys.cbor (mode 0600)
          - os:   Credential Manager, Keychain or the Secret Service

      --no-discovery
          Do not advertise or browse on the LAN (mDNS)

      --no-clipboard
          Do not host an OS clipboard backend (the daemon watches and writes the clipboard of its desktop session by default; `config.toml`: `clipboard = false`)

      --incoming-dir <DIR>
          Directory for accepted files (default: <state dir>/incoming)

      --relay-ca <FILE>
          PEM file with a CA certificate to trust for relay connections, besides the web PKI roots (a self-hosted relay with a private CA). May be given more than once. It only applies to an engine this command starts itself (the daemon, or an ephemeral engine), not to a running daemon

  -h, --help
          Print help (see a summary with '-h')

easysync transfer show #

Show one transfer

Usage: easysync transfer show [OPTIONS] <ID>

Argument	Required	Meaning
`<ID>`	yes

The full text of --help:

Show one transfer

Usage: easysync transfer show [OPTIONS] <ID>

Arguments:
  <ID>


Options:
      --listen <ADDR>
          QUIC listening address; default 0.0.0.0 on the preferred port (47017), or any free port

      --keystore <KEYSTORE>
          Where the identity and state keys live; overrides EASYSYNC_KEY_STORE. Default: the OS key store. There is no probing and no fallback

          Possible values:
          - file: The headless key file keys.cbor (mode 0600)
          - os:   Credential Manager, Keychain or the Secret Service

      --no-discovery
          Do not advertise or browse on the LAN (mDNS)

      --no-clipboard
          Do not host an OS clipboard backend (the daemon watches and writes the clipboard of its desktop session by default; `config.toml`: `clipboard = false`)

      --incoming-dir <DIR>
          Directory for accepted files (default: <state dir>/incoming)

      --relay-ca <FILE>
          PEM file with a CA certificate to trust for relay connections, besides the web PKI roots (a self-hosted relay with a private CA). May be given more than once. It only applies to an engine this command starts itself (the daemon, or an ephemeral engine), not to a running daemon

  -h, --help
          Print help (see a summary with '-h')

easysync clip #

Clipboard text

Usage: easysync clip [OPTIONS] <COMMAND>

Command	What it does
`easysync clip copy`	Send text to the connected peers that accept it
`easysync clip paste`	Print the latest text received from a peer

The full text of --help:

Clipboard text

Usage: easysync clip [OPTIONS] <COMMAND>

Commands:
  copy   Send text to the connected peers that accept it
  paste  Print the latest text received from a peer
  help   Print this message or the help of the given subcommand(s)

Options:
      --listen <ADDR>
          QUIC listening address; default 0.0.0.0 on the preferred port (47017), or any free port

      --keystore <KEYSTORE>
          Where the identity and state keys live; overrides EASYSYNC_KEY_STORE. Default: the OS key store. There is no probing and no fallback

          Possible values:
          - file: The headless key file keys.cbor (mode 0600)
          - os:   Credential Manager, Keychain or the Secret Service

      --no-discovery
          Do not advertise or browse on the LAN (mDNS)

      --no-clipboard
          Do not host an OS clipboard backend (the daemon watches and writes the clipboard of its desktop session by default; `config.toml`: `clipboard = false`)

      --incoming-dir <DIR>
          Directory for accepted files (default: <state dir>/incoming)

      --relay-ca <FILE>
          PEM file with a CA certificate to trust for relay connections, besides the web PKI roots (a self-hosted relay with a private CA). May be given more than once. It only applies to an engine this command starts itself (the daemon, or an ephemeral engine), not to a running daemon

  -h, --help
          Print help (see a summary with '-h')

easysync clip copy #

Send text to the connected peers that accept it

Usage: easysync clip copy [OPTIONS] <TEXT>

Option	Default	Meaning
`--to <PEER>`		Only these peers May be given more than once.

Argument	Required	Meaning
`<TEXT>`	yes

The full text of --help:

Send text to the connected peers that accept it

Usage: easysync clip copy [OPTIONS] <TEXT>

Arguments:
  <TEXT>


Options:
      --listen <ADDR>
          QUIC listening address; default 0.0.0.0 on the preferred port (47017), or any free port

      --to <PEER>
          Only these peers

      --keystore <KEYSTORE>
          Where the identity and state keys live; overrides EASYSYNC_KEY_STORE. Default: the OS key store. There is no probing and no fallback

          Possible values:
          - file: The headless key file keys.cbor (mode 0600)
          - os:   Credential Manager, Keychain or the Secret Service

      --no-discovery
          Do not advertise or browse on the LAN (mDNS)

      --no-clipboard
          Do not host an OS clipboard backend (the daemon watches and writes the clipboard of its desktop session by default; `config.toml`: `clipboard = false`)

      --incoming-dir <DIR>
          Directory for accepted files (default: <state dir>/incoming)

      --relay-ca <FILE>
          PEM file with a CA certificate to trust for relay connections, besides the web PKI roots (a self-hosted relay with a private CA). May be given more than once. It only applies to an engine this command starts itself (the daemon, or an ephemeral engine), not to a running daemon

  -h, --help
          Print help (see a summary with '-h')

easysync clip paste #

Print the latest text received from a peer

Usage: easysync clip paste [OPTIONS]

Option	Default	Meaning
`--event <ID>`		Only if it is the event with this id (32 hex characters, as `events` prints it); an engine that has received a newer event answers that it is gone

The full text of --help:

Print the latest text received from a peer

Usage: easysync clip paste [OPTIONS]

Options:
      --event <ID>
          Only if it is the event with this id (32 hex characters, as `events` prints it); an engine that has received a newer event answers that it is gone

      --listen <ADDR>
          QUIC listening address; default 0.0.0.0 on the preferred port (47017), or any free port

      --keystore <KEYSTORE>
          Where the identity and state keys live; overrides EASYSYNC_KEY_STORE. Default: the OS key store. There is no probing and no fallback

          Possible values:
          - file: The headless key file keys.cbor (mode 0600)
          - os:   Credential Manager, Keychain or the Secret Service

      --no-discovery
          Do not advertise or browse on the LAN (mDNS)

      --no-clipboard
          Do not host an OS clipboard backend (the daemon watches and writes the clipboard of its desktop session by default; `config.toml`: `clipboard = false`)

      --incoming-dir <DIR>
          Directory for accepted files (default: <state dir>/incoming)

      --relay-ca <FILE>
          PEM file with a CA certificate to trust for relay connections, besides the web PKI roots (a self-hosted relay with a private CA). May be given more than once. It only applies to an engine this command starts itself (the daemon, or an ephemeral engine), not to a running daemon

  -h, --help
          Print help (see a summary with '-h')

easysync relay #

Relays

Usage: easysync relay [OPTIONS] <COMMAND>

Command	What it does
`easysync relay list`	List the configured relays
`easysync relay add`	Add a relay; its access token is read from a prompt or stdin (base64url), never argv
`easysync relay provision`	Ask a relay for an access token and store it (`wss://` URL). Nothing is typed; the token is never shown. Prints the outcome and, on success, the line of `relay list`
`easysync relay remove`	Remove a relay

The full text of --help:

Relays

Usage: easysync relay [OPTIONS] <COMMAND>

Commands:
  list       List the configured relays
  add        Add a relay; its access token is read from a prompt or stdin (base64url), never argv
  provision  Ask a relay for an access token and store it (`wss://` URL). Nothing is typed; the token is never shown. Prints the outcome and, on success, the line of `relay list`
  remove     Remove a relay
  help       Print this message or the help of the given subcommand(s)

Options:
      --listen <ADDR>
          QUIC listening address; default 0.0.0.0 on the preferred port (47017), or any free port

      --keystore <KEYSTORE>
          Where the identity and state keys live; overrides EASYSYNC_KEY_STORE. Default: the OS key store. There is no probing and no fallback

          Possible values:
          - file: The headless key file keys.cbor (mode 0600)
          - os:   Credential Manager, Keychain or the Secret Service

      --no-discovery
          Do not advertise or browse on the LAN (mDNS)

      --no-clipboard
          Do not host an OS clipboard backend (the daemon watches and writes the clipboard of its desktop session by default; `config.toml`: `clipboard = false`)

      --incoming-dir <DIR>
          Directory for accepted files (default: <state dir>/incoming)

      --relay-ca <FILE>
          PEM file with a CA certificate to trust for relay connections, besides the web PKI roots (a self-hosted relay with a private CA). May be given more than once. It only applies to an engine this command starts itself (the daemon, or an ephemeral engine), not to a running daemon

  -h, --help
          Print help (see a summary with '-h')

easysync relay list #

List the configured relays

Usage: easysync relay list [OPTIONS]

The full text of --help:

List the configured relays

Usage: easysync relay list [OPTIONS]

Options:
      --listen <ADDR>
          QUIC listening address; default 0.0.0.0 on the preferred port (47017), or any free port

      --keystore <KEYSTORE>
          Where the identity and state keys live; overrides EASYSYNC_KEY_STORE. Default: the OS key store. There is no probing and no fallback

          Possible values:
          - file: The headless key file keys.cbor (mode 0600)
          - os:   Credential Manager, Keychain or the Secret Service

      --no-discovery
          Do not advertise or browse on the LAN (mDNS)

      --no-clipboard
          Do not host an OS clipboard backend (the daemon watches and writes the clipboard of its desktop session by default; `config.toml`: `clipboard = false`)

      --incoming-dir <DIR>
          Directory for accepted files (default: <state dir>/incoming)

      --relay-ca <FILE>
          PEM file with a CA certificate to trust for relay connections, besides the web PKI roots (a self-hosted relay with a private CA). May be given more than once. It only applies to an engine this command starts itself (the daemon, or an ephemeral engine), not to a running daemon

  -h, --help
          Print help (see a summary with '-h')

easysync relay add #

Add a relay; its access token is read from a prompt or stdin (base64url), never argv

Usage: easysync relay add [OPTIONS] <URL>

Option	Default	Meaning
`--shared`	`false`	Offer this relay to peers when pairing (unshares any other relay)

Argument	Required	Meaning
`<URL>`	yes

The full text of --help:

Add a relay; its access token is read from a prompt or stdin (base64url), never argv

Usage: easysync relay add [OPTIONS] <URL>

Arguments:
  <URL>


Options:
      --listen <ADDR>
          QUIC listening address; default 0.0.0.0 on the preferred port (47017), or any free port

      --shared
          Offer this relay to peers when pairing (unshares any other relay)

      --keystore <KEYSTORE>
          Where the identity and state keys live; overrides EASYSYNC_KEY_STORE. Default: the OS key store. There is no probing and no fallback

          Possible values:
          - file: The headless key file keys.cbor (mode 0600)
          - os:   Credential Manager, Keychain or the Secret Service

      --no-discovery
          Do not advertise or browse on the LAN (mDNS)

      --no-clipboard
          Do not host an OS clipboard backend (the daemon watches and writes the clipboard of its desktop session by default; `config.toml`: `clipboard = false`)

      --incoming-dir <DIR>
          Directory for accepted files (default: <state dir>/incoming)

      --relay-ca <FILE>
          PEM file with a CA certificate to trust for relay connections, besides the web PKI roots (a self-hosted relay with a private CA). May be given more than once. It only applies to an engine this command starts itself (the daemon, or an ephemeral engine), not to a running daemon

  -h, --help
          Print help (see a summary with '-h')

easysync relay provision #

Ask a relay for an access token and store it (wss:// URL). Nothing is typed; the token is never shown. Prints the outcome and, on success, the line of relay list

Usage: easysync relay provision [OPTIONS] <URL>

Argument	Required	Meaning
`<URL>`	yes

The full text of --help:

Ask a relay for an access token and store it (`wss://` URL). Nothing is typed; the token is never shown. Prints the outcome and, on success, the line of `relay list`

Usage: easysync relay provision [OPTIONS] <URL>

Arguments:
  <URL>


Options:
      --listen <ADDR>
          QUIC listening address; default 0.0.0.0 on the preferred port (47017), or any free port

      --keystore <KEYSTORE>
          Where the identity and state keys live; overrides EASYSYNC_KEY_STORE. Default: the OS key store. There is no probing and no fallback

          Possible values:
          - file: The headless key file keys.cbor (mode 0600)
          - os:   Credential Manager, Keychain or the Secret Service

      --no-discovery
          Do not advertise or browse on the LAN (mDNS)

      --no-clipboard
          Do not host an OS clipboard backend (the daemon watches and writes the clipboard of its desktop session by default; `config.toml`: `clipboard = false`)

      --incoming-dir <DIR>
          Directory for accepted files (default: <state dir>/incoming)

      --relay-ca <FILE>
          PEM file with a CA certificate to trust for relay connections, besides the web PKI roots (a self-hosted relay with a private CA). May be given more than once. It only applies to an engine this command starts itself (the daemon, or an ephemeral engine), not to a running daemon

  -h, --help
          Print help (see a summary with '-h')

easysync relay remove #

Remove a relay

Usage: easysync relay remove [OPTIONS] <URL>

Argument	Required	Meaning
`<URL>`	yes

The full text of --help:

Remove a relay

Usage: easysync relay remove [OPTIONS] <URL>

Arguments:
  <URL>


Options:
      --listen <ADDR>
          QUIC listening address; default 0.0.0.0 on the preferred port (47017), or any free port

      --keystore <KEYSTORE>
          Where the identity and state keys live; overrides EASYSYNC_KEY_STORE. Default: the OS key store. There is no probing and no fallback

          Possible values:
          - file: The headless key file keys.cbor (mode 0600)
          - os:   Credential Manager, Keychain or the Secret Service

      --no-discovery
          Do not advertise or browse on the LAN (mDNS)

      --no-clipboard
          Do not host an OS clipboard backend (the daemon watches and writes the clipboard of its desktop session by default; `config.toml`: `clipboard = false`)

      --incoming-dir <DIR>
          Directory for accepted files (default: <state dir>/incoming)

      --relay-ca <FILE>
          PEM file with a CA certificate to trust for relay connections, besides the web PKI roots (a self-hosted relay with a private CA). May be given more than once. It only applies to an engine this command starts itself (the daemon, or an ephemeral engine), not to a running daemon

  -h, --help
          Print help (see a summary with '-h')

easysync reset #

Erase the state of this device (offline: it never starts an engine). Stop a daemon or an app that hosts the engine first

Usage: easysync reset [OPTIONS]

Option	Default	Meaning
`--keep-identity`	`false`	Keep the identity and the fingerprint: replace the state key and erase the state, the pairings, the relays and the settings. A repair, not a security measure
`--dry-run`	`false`	Print what would happen and which check would refuse it, then exit with 0
`--yes`	`false`	Do not ask on the terminal (scripts, containers)

The full text of --help:

Erase the state of this device (offline: it never starts an engine). Stop a daemon or an app that hosts the engine first

Usage: easysync reset [OPTIONS]

Options:
      --keep-identity
          Keep the identity and the fingerprint: replace the state key and erase the state, the pairings, the relays and the settings. A repair, not a security measure

      --listen <ADDR>
          QUIC listening address; default 0.0.0.0 on the preferred port (47017), or any free port

      --dry-run
          Print what would happen and which check would refuse it, then exit with 0

      --keystore <KEYSTORE>
          Where the identity and state keys live; overrides EASYSYNC_KEY_STORE. Default: the OS key store. There is no probing and no fallback

          Possible values:
          - file: The headless key file keys.cbor (mode 0600)
          - os:   Credential Manager, Keychain or the Secret Service

      --no-discovery
          Do not advertise or browse on the LAN (mDNS)

      --yes
          Do not ask on the terminal (scripts, containers)

      --no-clipboard
          Do not host an OS clipboard backend (the daemon watches and writes the clipboard of its desktop session by default; `config.toml`: `clipboard = false`)

      --incoming-dir <DIR>
          Directory for accepted files (default: <state dir>/incoming)

      --relay-ca <FILE>
          PEM file with a CA certificate to trust for relay connections, besides the web PKI roots (a self-hosted relay with a private CA). May be given more than once. It only applies to an engine this command starts itself (the daemon, or an ephemeral engine), not to a running daemon

  -h, --help
          Print help (see a summary with '-h')

easysync daemon #

Run the engine in the foreground and serve the local IPC

Usage: easysync daemon [OPTIONS] [COMMAND]

Command	What it does
`easysync daemon stop`	Ask the running daemon to stop

The full text of --help:

Run the engine in the foreground and serve the local IPC

Usage: easysync daemon [OPTIONS] [COMMAND]

Commands:
  stop  Ask the running daemon to stop
  help  Print this message or the help of the given subcommand(s)

Options:
      --listen <ADDR>
          QUIC listening address; default 0.0.0.0 on the preferred port (47017), or any free port

      --keystore <KEYSTORE>
          Where the identity and state keys live; overrides EASYSYNC_KEY_STORE. Default: the OS key store. There is no probing and no fallback

          Possible values:
          - file: The headless key file keys.cbor (mode 0600)
          - os:   Credential Manager, Keychain or the Secret Service

      --no-discovery
          Do not advertise or browse on the LAN (mDNS)

      --no-clipboard
          Do not host an OS clipboard backend (the daemon watches and writes the clipboard of its desktop session by default; `config.toml`: `clipboard = false`)

      --incoming-dir <DIR>
          Directory for accepted files (default: <state dir>/incoming)

      --relay-ca <FILE>
          PEM file with a CA certificate to trust for relay connections, besides the web PKI roots (a self-hosted relay with a private CA). May be given more than once. It only applies to an engine this command starts itself (the daemon, or an ephemeral engine), not to a running daemon

  -h, --help
          Print help (see a summary with '-h')

easysync daemon stop #

Ask the running daemon to stop

Usage: easysync daemon stop [OPTIONS]

The full text of --help:

Ask the running daemon to stop

Usage: easysync daemon stop [OPTIONS]

Options:
      --listen <ADDR>
          QUIC listening address; default 0.0.0.0 on the preferred port (47017), or any free port

      --keystore <KEYSTORE>
          Where the identity and state keys live; overrides EASYSYNC_KEY_STORE. Default: the OS key store. There is no probing and no fallback

          Possible values:
          - file: The headless key file keys.cbor (mode 0600)
          - os:   Credential Manager, Keychain or the Secret Service

      --no-discovery
          Do not advertise or browse on the LAN (mDNS)

      --no-clipboard
          Do not host an OS clipboard backend (the daemon watches and writes the clipboard of its desktop session by default; `config.toml`: `clipboard = false`)

      --incoming-dir <DIR>
          Directory for accepted files (default: <state dir>/incoming)

      --relay-ca <FILE>
          PEM file with a CA certificate to trust for relay connections, besides the web PKI roots (a self-hosted relay with a private CA). May be given more than once. It only applies to an engine this command starts itself (the daemon, or an ephemeral engine), not to a running daemon

  -h, --help
          Print help (see a summary with '-h')

A relay forwards encrypted data. It does see IP addresses, timing and volume of the connections that use it: what the relay sees.