intermodal fork (public API)
Go to file
Casey Rodarmor 6996d1a3ea
List supported OSs in readme
type: documentation
2020-04-07 19:01:33 -07:00
.github/workflows Fix condition in GHA workflow 2020-04-07 19:01:32 -07:00
bin Improve book 2020-04-07 19:01:30 -07:00
book Improve book 2020-04-07 19:01:30 -07:00
src Allow sorting files in torrents 2020-04-07 19:01:32 -07:00
tmp Initial commit 2020-04-07 18:55:30 -07:00
www Go back to sans-serif I in site logo 2020-04-07 19:01:32 -07:00
.gitattributes Format with unstable rustfmt options 2020-04-07 19:01:07 -07:00
.gitignore Use serifed I for intermodal on site 2020-04-07 19:01:31 -07:00
build.rs Fix release process issues 2020-04-07 19:01:29 -07:00
Cargo.lock Use open crate to open files and URLs 2020-04-07 19:01:31 -07:00
Cargo.toml Use open crate to open files and URLs 2020-04-07 19:01:31 -07:00
CHANGELOG.md Release v0.0.3 2020-04-07 19:01:29 -07:00
CONTRIBUTING Initial commit 2020-04-07 18:55:30 -07:00
justfile Add cargo install cargo-watch to dev-deps recipe 2020-04-07 19:01:32 -07:00
LICENSE Initial commit 2020-04-07 18:55:30 -07:00
README.md List supported OSs in readme 2020-04-07 19:01:33 -07:00
rustfmt.toml Format with unstable rustfmt options 2020-04-07 19:01:07 -07:00
src.torrent Improve book 2020-04-07 19:01:30 -07:00

intermodal: a 40' shipping container for the Internet

Crate Build Chat

Intermodal is a user-friendly and featureful command-line BitTorrent metainfo utility. The binary is called imdl and runs on Linux, Windows, and macOS.

At the moment, creation, viewing, and verification of .torrent files is supported.

For more about the project and its goals, check out this post.

Manual

General

Installation

Supported Operating Systems

imdl supports both unix and Windows. It is tested on Linux, MacOS, and Windows, but should work on other unix OSs. If it does not, please open an issue!

Pre-built binaries

Pre-built binaries for Linux, macOS, and Windows can be found on the releases page.

You can use the following command to download the latest binary for Linux, MacOS or Windows, just replace DEST with the directory where you'd like to install the imdl binary:

curl --proto '=https' --tlsv1.2 -sSf https://imdl.io/install.sh | bash -s -- --to DEST

Cargo

imdl is written in Rust and can be built from source and installed with cargo install imdl. To get Rust, use the rustup installer.

Semantic Versioning

Intermodal follows semantic versioning.

In particular:

  • v0.0.X: Breaking changes may be introduced at any time.
  • v0.X.Y: Breaking changes may only be introduced with a minor version number bump.
  • vX.Y.Z: Breaking changes may only be introduced with a major version number bump

Unstable Features

To avoid premature stabilization and excessive version churn, unstable features are unavailable unless the --unstable / -u flag is passed, for example imdl --unstable torrent create .. Unstable features may be changed or removed at any time.

Acknowledgments

The formatting of imdl torrent show is entirely copied from torf, an excellent command-line torrent creator, editor, and viewer.