2019-05-24 10:25:55 +02:00
# intermodal: a 40' shipping container for the Internet
2020-01-16 08:37:12 +01:00
2020-02-18 12:07:38 +01:00
[](https://crates.io/crates/imdl)
[](https://github.com/casey/intermodal/actions)
2020-02-18 13:14:09 +01:00
[](https://discord.gg/HaaT5Qz)
2020-02-18 11:53:23 +01:00
2020-03-27 22:19:21 +01:00
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.
2020-03-27 05:54:54 +01:00
For more about the project and its goals, check out [this post ](https://rodarmor.com/blog/intermodal ).
2020-03-14 08:32:13 +01:00
2020-03-28 11:56:08 +01:00
2020-01-21 06:41:39 +01:00
## Manual
- [General ](#general )
2020-01-31 11:58:58 +01:00
- [Installation ](#installation )
- [Supported Operating Systems ](#supported-operating-systems )
- [Pre-built binaries ](#pre-built-binaries )
- [Cargo ](#cargo )
2020-03-28 06:46:41 +01:00
- [Shell Completion Scripts ](#shell-completion-scripts )
2020-01-21 06:41:39 +01:00
- [Semantic Versioning ](#semantic-versioning )
- [Unstable Features ](#unstable-features )
2020-02-04 16:55:50 +01:00
- [Acknowledgments ](#acknowledgments )
2020-01-21 06:41:39 +01:00
## General
2020-01-31 11:58:58 +01:00
### 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 ](https://github.com/casey/intermodal/releases ).
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:
```sh
2020-01-31 13:28:40 +01:00
curl --proto '=https' --tlsv1.2 -sSf https://imdl.io/install.sh | bash -s -- --to DEST
2020-01-31 11:58:58 +01:00
```
#### Cargo
`imdl` is written in [Rust ](https://www.rust-lang.org/ ) and can be built from
source and installed with `cargo install imdl` . To get Rust, use the
[rustup installer ](https://rustup.rs/ ).
2020-03-28 06:46:41 +01:00
### Shell Completion Scripts
Shell completion scripts for Bash, Zsh, Fish, PowerShell, and Elvish are
available in the [completions ](completions directory ). Please refer to your
shell's documentation for how to install them.
The `imdl` binary can also generate the same completion scripts at runtime,
using the `completions` command:
```sh
$ imdl completions --shell bash > imdl.bash
```
2020-01-21 06:41:39 +01:00
### Semantic Versioning
Intermodal follows [semantic versioning ](https://semver.org/ ).
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
2020-01-30 10:52:07 +01:00
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.
2020-01-21 06:41:39 +01:00
2020-02-04 16:55:50 +01:00
## Acknowledgments
The formatting of `imdl torrent show` is entirely copied from
[torf ](https://github.com/rndusr/torf-cli ), an excellent command-line torrent
creator, editor, and viewer.
