# synkremote > A CLI tool to share files/directories between remote systems. Latest version **1.1.0** (published 2023-08-06) · ISC license · 0 weekly downloads ## Install ```sh npm install synkremote pnpm add synkremote yarn add synkremote bun add synkremote ``` Provides the command `synkremote`. ## Health **Score 20/100 (F)** — status: abandoned. Positive: has types; no vulnerabilities. Warnings: low downloads; no esm support. Negative: abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 1.1.0 | | Published | 2023-08-06 | | First published | 2022-05-08 | | Weekly downloads | 0 | | License | ISC | | TypeScript types | bundled | | Module format | CommonJS | | Dependencies | 3 | | Unpacked size | 40.1 KB | | Known vulnerabilities | 0 | | Install scripts | no | | Maintainers | abhishek0032 | | Keywords | file, directory, sync, transfer, remote | ## Links - npm: https://www.npmjs.com/package/synkremote - Homepage: https://github.com/uint4096/synkremote - npm.io page: https://npm.io/package/synkremote ## Dependencies (3) - [minimist](https://npm.io/package/minimist.md) ^1.2.8 - [fast-glob](https://npm.io/package/fast-glob.md) ^3.2.11 - [protocol-buffers](https://npm.io/package/protocol-buffers.md) ^5.0.0 ## Alternatives - [unionfs](https://npm.io/package/unionfs.md) — 2.2M weekly downloads - [path-starts-with](https://npm.io/package/path-starts-with.md) — 35.9K weekly downloads - [redzip](https://npm.io/package/redzip.md) — 1.2K weekly downloads - [vscode-anymatch](https://npm.io/package/vscode-anymatch.md) — 848 weekly downloads - [@ledgerhq/coin-filecoin](https://npm.io/package/@ledgerhq/coin-filecoin.md) — 793 weekly downloads ## Recent versions - 1.1.0 (latest) — 2023-08-06 - 1.0.4 — 2022-09-19 - 1.0.3 — 2022-05-11 - 1.0.2 — 2022-05-11 - 1.0.1 — 2022-05-11 - 1.0.0 — 2022-05-08 ## README # synkremote ## Description A CLI tool to share files/directories between remote systems. ## Installation npm i --global synkremote ## Usage ### Receive The system receiving the files should have the synkremote server running. To start the server, run: synkremote --bindIp= #### Options | Name | Description | Required | | --------- | ----------------------------------------------------------------------------- | -------- | | --port | The port to start the server on. Defaults to 8080. | No | | --rootDir | The directory where the received files are stored. Defaults to _~/synkremote_ | No | | --bindIp | The IPv4 address to bind synkremote to. Binds to _localhost_ by default. | No | | --help | Show help | - | ### Send Synkremote supports sending both files and directories. You can send data by running: synkremote send [options] For example, to send the directory _~/my-dir_ to a remote system _synkhost.com_, where the synkremote server is running on port _8080_, you can run: synkremote send --addr synkhost.com:8080 --dir ~/my-dir You can use the _--file_ option to send a file. synkremote send --addr synkhost.com:8080 --file ~/my-dir/myFile.txt You can also specify glob patterns to include or exclude files and directories. For example, to just send files ending in _.js_, you can run: synkremote send --addr synkhost.com:8080 --dir ~/my-dir --include "**/*.js" Similarly, to exclude the files in the _tmp_ directory within _~/my-dir_, you can run: synkremote send --addr synkhost.com:8080 --dir ~/my-dir --exclude "tmp/*" You can specfiy multiple patterns in the _include_ and _exclude_ files respectively. These files must be created in the _~/.config/synkremote_ directory. #### Options | Name | Description | Required | | ----------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------- | | --addr | The address of the server receiving the files in the _host:port_ format. | No | | --host | The IPv4 address or hostname of the remote server. An alternative to the --addr option. | Yes if the _--addr_ option is not provided, otherwise no | | --port | The port on which the synkremote server is running on the remote server. Defaults to 8080. | No | | --file | The file to send to the remote server. | No | | --dir | The directory to send to the remote server. | Yes if the _--file_ option is not provided, otherwise no | | --remoteDir | The name of the directory on the remote server.
Defaults to the current name of the directory if the _--dir_ option is provided.
If the _--file_ option is provided, defaults to the name of the directory in which the file currently exists. | No | | --include | Glob pattern to specify which files to include.
Defaults to the patterns specified in the _include_ file in _~/.config/synkremote_.
Defaults to \*\*\*/\** if the *include\* file does not exist. | No | | --exclude | Glob pattern to specify which files to exclude.
Defaults to the patterns specified in the _exclude_ file in _~/.config/synkremote_.
Defaults to _null_ if the _exclude_ file does not exist. | No | | --help | Show help | - | ## License This tool is distributed under the MIT License. See the LICENSE file for more information. --- _Source: https://npm.io/package/synkremote · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._