Skip to content

Commit

Permalink
readme: Add README for CLI
Browse files Browse the repository at this point in the history
  • Loading branch information
felinira committed Jul 17, 2024
1 parent b1ee7d8 commit c079dde
Show file tree
Hide file tree
Showing 2 changed files with 47 additions and 1 deletion.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ New features that exceed the other implementations:

## Getting started

If you want to toy with the CLI, `cargo run -- --help` will get you started. The code sits in `./cli/src/bin`.
If you want to toy with the CLI, `cargo run -- --help` will get you started. The code sits in `./cli/src`. For more instructions see [cli/README.md](cli/README.md).

If you'd like to use Wormhole in your application, `cargo doc --open` will tell you how to use it. There aren't any hosted docs at the moment.

Expand Down
46 changes: 46 additions & 0 deletions cli/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
# Magic Wormhole CLI

A rust implementation of the classic `magic-wormhole` command line client.

## Installation

### GitHub Releases

We publish source code and binaries to GitHub releases. Visit the [releases page](https://github.com/magic-wormhole/magic-wormhole.rs/releases) for the latest release.

Or use [cargo binstall](https://github.com/cargo-bins/cargo-binstall):

```bash
cargo binstall magic-wormhole-cli
```

### crates.io

You can use cargo to install the CLI from crates.io:

```bash
cargo install --locked magic-wormhole-cli
```

## Usage

```text
Get things from one computer to another, safely
Usage: wormhole-rs [OPTIONS] <COMMAND>
Commands:
send Send a file or a folder [aliases: tx]
receive Receive a file or a folder [aliases: rx]
send-many Send a file to many recipients
forward Forward ports from one machine to another
Options:
-v, --verbose Enable logging to stdout, for debugging purposes
-h, --help Print help
-V, --version Print version
Run a subcommand with `--help` to know how it's used.
To send files, use `wormhole send <PATH>`.
To receive files, use `wormhole receive <CODE>`.
```

0 comments on commit c079dde

Please sign in to comment.