README.md

March 5, 2026 ยท View on GitHub

Distant

Documentation | Discussion

Crates.io Docs.rs CI RustC 1.88.0+

๐Ÿšง (Alpha stage software) This program is in rapid development and may break or change frequently! ๐Ÿšง

Installation

Unix

# Need to include -L to follow redirects as this returns 301
curl -L https://sh.distant.dev | sh

# Can also use wget to the same result
wget -q -O- https://sh.distant.dev | sh

See https://distant.dev/getting-started/installation/unix/ for more details.

Windows

Set-ExecutionPolicy RemoteSigned -Scope CurrentUser # Optional: Needed to run a remote script the first time
irm sh.distant.dev | iex

See https://distant.dev/getting-started/installation/windows/ for more details.

Usage

# SSH into a server and open a shell
distant ssh example.com

# Read the remote current working directory
distant fs read .

# Run a command on the remote machine
distant spawn -- ls -la

See https://distant.dev/getting-started/usage/ for more details.

Documentation

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.