Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Provide an example command-line app #61

Open
Demi-Marie opened this issue Nov 17, 2019 · 5 comments
Open

Provide an example command-line app #61

Demi-Marie opened this issue Nov 17, 2019 · 5 comments
Labels
enhancement New feature or request good first issue Good for newcomers

Comments

@Demi-Marie
Copy link
Contributor

We should provide an example command-line tool that demonstrates using yamux. The first one that comes to mind is a socket forwarder: it listens on a socket (AF_UNIX or TCP) on one side, and multiplexes connections over stdio to its peer, which connects to a socket passed as a command-line argument.

@twittner twittner added enhancement New feature or request good first issue Good for newcomers labels Nov 18, 2019
@hilt0n
Copy link

hilt0n commented Mar 3, 2021

I would propose as first example the same as in the initial Go version library from Hashicorp (https://github.com/hashicorp/yamux#usage).
The example in the README runs in less than 5 minutes and it would be nice to have a similar and compatible example in this repo.

@mxinden
Copy link
Member

mxinden commented Mar 3, 2021

I would propose as first example the same as in the initial Go version library from Hashicorp (https://github.com/hashicorp/yamux#usage).

Example looks like a good first start to me. @hilt0n would you like to create a pull request?

@hilt0n
Copy link

hilt0n commented Mar 3, 2021

I just discovered Yamux, started diving into your lib and async Rust at the same time but once I'm more in confidence, I will try to create that.

@mxinden
Copy link
Member

mxinden commented Mar 3, 2021

Cool. Let us know whenever you have questions @hilt0n!

@nwtgck
Copy link

nwtgck commented Jan 29, 2022

Thank you so much for creating yamux in Rust implementation.

I need yamux CLI and made it.
Repository: https://github.com/nwtgck/yamux-cli-rust/tree/a3ce29

See some examples in REAME to know how it behaves and src/main.rs for the implementation. The CLI is designed like netcat for combining commands with Unix pipes beautifully.

I keep the code simple. I hope it would help someone to use yamux in Rust.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

5 participants