Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/forestnode-io/oneshot
A first-come first-served single-fire HTTP server. Easily transfer files to and from your terminal and any browser.
https://github.com/forestnode-io/oneshot
cli command-line file-transfer nat-traversal p2p terminal upnp-portmapper webrtc
Last synced: 3 days ago
JSON representation
A first-come first-served single-fire HTTP server. Easily transfer files to and from your terminal and any browser.
- Host: GitHub
- URL: https://github.com/forestnode-io/oneshot
- Owner: forestnode-io
- License: mit
- Created: 2020-06-10T22:09:23.000Z (over 4 years ago)
- Default Branch: v2
- Last Pushed: 2023-11-04T01:37:50.000Z (about 1 year ago)
- Last Synced: 2024-04-10T10:21:16.603Z (7 months ago)
- Topics: cli, command-line, file-transfer, nat-traversal, p2p, terminal, upnp-portmapper, webrtc
- Language: Go
- Homepage: https://www.oneshot.uno
- Size: 2.53 MB
- Stars: 328
- Watchers: 11
- Forks: 9
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-repositories - forestnode-io/oneshot - A first-come first-served single-fire HTTP server. Easily transfer files to and from your terminal and any browser. (Go)
README
## oneshot v2
A single-fire first-come-first-serve HTTP server.
### Features
- Send and receive to and from stdin or stdout.
- Use external executables to process and respond to HTTP requests.
- Reverse proxy and redirect HTTP requests.
- Multiple methods of NAT traversal: UPnP-IGD, STUN and TURN (ICE).
- Support for cloud integration with built in discovery / signalling server to allow for self hosted instances.
- Works with any HTTP client including browsers, only one person needs to have oneshot installed.
- Support for rich, machine-readable output; easily integrate oneshot into your pipelines.
- Highly configurable HTTP responses, custom upload clients, and more.
#### A video overview of oneshot (v1) (thanks to Brodie Robertson)
### Installation
There are multiple ways of obtaining oneshot:
#### Download binary (easiest)
```shell
curl -L https://github.com/forestnode-io/oneshot/raw/v2/v2/install.sh | sudo sh
```
#### Linux / macOS
Copy and paste any of these commands into your terminal to install oneshot.
For some portion of Linux users, there are .deb and .rpm packages available in the [release page](https://github.com/forestnode-io/oneshot/releases).
##### Brew
```bash
brew tap forestnode-io/brew
brew install forestnode-io/brew/oneshot
```
##### Go get
```bash
go get -u -v github.com/forestnode-io/oneshot/v2
```
##### Compiling from source
```bash
git clone https://github.com/forestnode-io/oneshot
cd oneshot/v2
sudo make install
```
#### Windows
##### Download executable
Head over to the [release page](https://github.com/forestnode-io/oneshot/releases) and download the windows .zip file.
##### Go get
```powershell
go get -u -v github.com/forestnode-io/oneshot/v2
```
### Use Cases & Examples
#### Send a file
```bash
$ oneshot send path/to/file.txt
```
Then, from a browser (or any HTTP client) simply go to your computers I.P. address and the file download will be triggered.
#### Send a file securely
```bash
$ oneshot send -u username -W path/to/file.txt
```
The `-W` option will cause oneshot to prompt you for a password.
Oneshot also supports HTTPS, simply pass in the key and certificate using the `--tls-key` and `--tls-cert` flags.
#### Receive a file
```bash
$ oneshot receive .
```
The `receive` subcommand is used for receiving data from the client.
A connecting browser will be prompted to upload a file which oneshot then save to the current directory.
#### Receive a file to standard out
```bash
$ oneshot receive | jq '.first_name'
```
If the receive subcommand is used and no directory is given, oneshot will write the received file to its standard out.
#### Serve up a first-come-first-serve web page
```bash
$ oneshot send -D my/web/page.html
```
The `-D` flag tells oneshot to not trigger a download client-side.
#### Send the results of a lengthy process
```bash
$ sudo apt update | oneshot send -n apt-update.txt
```
Oneshot can transfer from its standard input; by default files are given a random name.
The optional flag `-n` sets the name of the file.
#### Wait until someone provides credentials to start a process, then send its output
```bash
$ oneshot send -u foo -P password -c my_non-cgi_script.sh
```
Oneshot can run your scripts and programs in a CGI flexible CGI environment.
Even non-CGI executables may be used; oneshot will provide its own default headers or you can set your own using the `-H` flag.
#### Create a single-fire api in a single line
```bash
$ oneshot exec -- 'echo "Hello $(jq -r '.name')!"'
```
Here, the `exec` subcommand tells oneshot to run its input as a shell command in a flexible CGI environment.
In another terminal we can test our api:
```bash
$ curl -X POST -H 'Content-Type: application/json' -d '{"name": "world"}' localhost:8080
Hello World!
```
#### Receive a file, do work on it locally and send back the results
```bash
$ oneshot -u | gofmt | oneshot -J
```
The `-J` flag we are using here tells oneshot to only start serving HTTP once it has received an EOF from its stdin.
This allows us to create unix pipelines without needing to specify a different port for each instance of oneshot.
In this scenario, the user would upload or type in some Go code and upon hitting the back button (refresh won't work !) or going back to the original URL, the user will receive their formatted Go code.
### Reporting Bugs, Feature Requests & Contributing
Please report any bugs or issues [here](https://github.com/forestnode-io/oneshot/issues).
I consider oneshot to be *nearly* feature complete; feature requests and contributions are welcome.