🚧 (Alpha stage software) Library and tooling that supports remote filesystem and process operations. 🚧
You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Go to file
Chip Senkbeil 93532480d7
Add installation section to readme
3 years ago
.cargo Initial commit 3 years ago
src Fix bug where writing file did not work from cli, add text options for write and append, bump to 0.3.2 3 years ago
.gitignore Add installation section to readme 3 years ago
BUILDING.md Update building instructions 3 years ago
Cargo.lock Fix bug where writing file did not work from cli, add text options for write and append, bump to 0.3.2 3 years ago
Cargo.toml Fix bug where writing file did not work from cli, add text options for write and append, bump to 0.3.2 3 years ago
README.md Add installation section to readme 3 years ago

README.md

distant

Crates.io Docs.rs

Binary to connect with a remote machine to edit files and run programs.

Details

The distant binary supplies both a server and client component as well as a command to start a server and configure the local client to be able to talk to the server.

Installation

Prebuilt Binaries

If you would like a pre-built binary, check out the releases section.

Building from Source

If you have cargo installed, you can directly download and build the source via:

cargo install distant

Alternatively, you can clone this repository and build from source following the build guide.

Examples

Launch a remote instance of distant by SSHing into another machine and starting the distant executable:

# Connects to my.example.com on port 22 via SSH to start a new session
distant launch my.example.com

# After the session is established, you can perform different operations
# on the remote machine via `distant action {command} [args]`
distant action copy path/to/file new/path/to/file
distant action proc-run -- echo 'Hello, this is from the other side'

License

This project is licensed under either of

Apache License, Version 2.0, (LICENSE-APACHE or apache-license) MIT license (LICENSE-MIT or mit-license) at your option.