Crate distant

Documentation | Discussion

🚧 (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 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

# Start a manager in the background
distant manager listen &

# SSH into a server, start distant, and connect to the distant server
distant launch ssh://example.com

# Read the current working directory
distant fs read .

# Start a shell on the remote machine
distant shell

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

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.

Structs

Cli

Represents the primary CLI entrypoint

MainResult

Wrapper around a CliResult that provides Termination support and Formating.

Options

Primary entrypoint into options & subcommands for the CLI.

Enums

CliError

Represents an error associated with the CLI

Format

Represents the format to use for output from a command.

OptionsError

Represents an error associated with parsing options.

Type Aliases

CliResult