Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hueristiq/xtee
A versatile command-line interface (CLI) utility for handling data streams in Unix-like environments. It serves as a crucial link between standard input and dual outputs, taking a single stream of input and splitting it into two outputs, one to the standard output and the other to a file simultaneously.
https://github.com/hueristiq/xtee
cli command-line-interface data-streams go golang stdin stdin-stream stdout stdout-stream
Last synced: about 2 months ago
JSON representation
A versatile command-line interface (CLI) utility for handling data streams in Unix-like environments. It serves as a crucial link between standard input and dual outputs, taking a single stream of input and splitting it into two outputs, one to the standard output and the other to a file simultaneously.
- Host: GitHub
- URL: https://github.com/hueristiq/xtee
- Owner: hueristiq
- License: mit
- Created: 2023-10-09T10:34:13.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-10-20T21:58:05.000Z (2 months ago)
- Last Synced: 2024-10-22T09:48:08.842Z (2 months ago)
- Topics: cli, command-line-interface, data-streams, go, golang, stdin, stdin-stream, stdout, stdout-stream
- Language: Go
- Homepage: https://github.com/hueristiq/xstream
- Size: 66.4 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# xtee
 [](https://goreportcard.com/report/github.com/hueristiq/xtee) [](https://github.com/hueristiq/xtee/releases) [](https://github.com/hueristiq/xtee/issues?q=is:issue+is:open) [](https://github.com/hueristiq/xtee/issues?q=is:issue+is:closed) [](https://github.com/hueristiq/xtee/blob/master/LICENSE)  [](https://github.com/hueristiq/xtee/blob/master/CONTRIBUTING.md)
`xtee` is a versatile command-line utility handy in taking a single stream of input, from standard input, and splitting it into two outputs, standard output and file.
## Resources
* [Features](#features)
* [Installation](#installation)
* [Install release binaries (Without Go Installed)](#install-release-binaries-without-go-installed)
* [Install source (With Go Installed)](#install-source-with-go-installed)
* [`go install ...`](#go-install)
* [`go build ...` the development Version](#go-build--the-development-version)
* [Usage](#usage)
* [Contributing](#contributing)
* [Licensing](#licensing)
* [Credits](#credits)
* [Contributors](#contributors)
* [Similar Projects](#similar-projects)
## Features
* Splits incoming standard input into standard output and file.
* Supports soaking up input before writing to output file.
* Supports appending and overwriting outputs.
* Supports deduplication.
* Cross-Platform (Windows, Linux & macOS).
## Installation
### Install release binaries (without Go installed)
Visit the [releases page](https://github.com/hueristiq/xtee/releases) and find the appropriate archive for your operating system and architecture. Download the archive from your browser or copy its URL and retrieve it with `wget` or `curl`:
* ...with `wget`:
```bash
wget https://github.com/hueristiq/xtee/releases/download/v/xtee--linux-amd64.tar.gz
```
* ...or, with `curl`:
```bash
curl -OL https://github.com/hueristiq/xtee/releases/download/v/xtee--linux-amd64.tar.gz
```
...then, extract the binary:
```bash
tar xf xtee--linux-amd64.tar.gz
```
> [!TIP]
> The above steps, download and extract, can be combined into a single step with this onliner
>
> ```bash
> curl -sL https://github.com/hueristiq/xtee/releases/download/v/xtee--linux-amd64.tar.gz | tar -xzv
> ```
> [!NOTE]
> On Windows systems, you should be able to double-click the zip archive to extract the `xtee` executable.
...move the `xtee` binary to somewhere in your `PATH`. For example, on GNU/Linux and OS X systems:
```bash
sudo mv xtee /usr/local/bin/
```
> [!NOTE]
> Windows users can follow [How to: Add Tool Locations to the PATH Environment Variable](https://msdn.microsoft.com/en-us/library/office/ee537574(v=office.14).aspx) in order to add `xtee` to their `PATH`.
### Install source (with Go installed)
Before you install from source, you need to make sure that Go is installed on your system. You can install Go by following the official instructions for your operating system. For this, we will assume that Go is already installed.
#### `go install ...`
```bash
go install -v github.com/hueristiq/xtee/cmd/xtee@latest
```
#### `go build ...` the development version
* Clone the repository
```bash
git clone https://github.com/hueristiq/xtee.git
```
* Build the utility
```bash
cd xtee/cmd/xtee && \
go build .
```
* Move the `xtee` binary to somewhere in your `PATH`. For example, on GNU/Linux and OS X systems:
```bash
sudo mv xtee /usr/local/bin/
```
Windows users can follow [How to: Add Tool Locations to the PATH Environment Variable](https://msdn.microsoft.com/en-us/library/office/ee537574(v=office.14).aspx) in order to add `xtee` to their `PATH`.
> [!CAUTION]
> While the development version is a good way to take a peek at `xtee`'s latest features before they get released, be aware that it may have bugs. Officially released versions will generally be more stable.
## Usage
To display help message for `xtee` use the `-h` flag:
```bash
xtee -h
```
help message:
```text
_
__ _| |_ ___ ___
\ \/ / __/ _ \/ _ \
> <| || __/ __/
/_/\_\\__\___|\___|
v0.4.0
USAGE:
xtee [OPTION]...
INPUT OPTIONS:
--soak bool soak up all input before writing to file
OUTPUT OPTIONS:
-u, --unique bool output unique lines
-a, --append bool append lines to output
-q, --quiet bool suppress output to stdout
-p, --preview bool preview new lines, without writing to file
pflag: help requested
```
* Appending Unique Lines to File
```
➜ cat stuff.txt
one
two
three
➜ cat new-stuff.txt
zero
one
two
three
four
five
➜ cat new-stuff.txt | xtee stuff.txt --append --unique
zero
four
five
➜ cat stuff.txt
one
two
three
zero
four
five
```
Note that the new lines added to `stuff.txt` are also sent to `stdout`, this allows for them to be redirected to another file:
```
➜ cat new-stuff.txt | xtee stuff.txt --append --unique > added-lines.txt
➜ cat added-lines.txt
zero
four
five
```
* Deduplicating Files
```
➜ cat stuff.txt
zero
one
two
three
zero
four
five
five
➜ cat stuff.txt | xtee stuff.txt --soak --unique
zero
one
two
three
four
five
➜ cat stuff.txt
zero
one
two
three
four
five
```
Note the use of `--soak`, it makes the utility soak up all its input before writing to a file. This is useful for reading from and writing to the same file in a single pipeline.
## Contributing
We welcome contributions! Feel free to submit [Pull Requests](https://github.com/hueristiq/xtee/pulls) or report [Issues](https://github.com/hueristiq/xtee/issues). For more details, check out the [contribution guidelines](https://github.com/hueristiq/xtee/blob/master/CONTRIBUTING.md).
## Licensing
This utility is licensed under the [MIT license](https://opensource.org/license/mit). You are free to use, modify, and distribute it, as long as you follow the terms of the license. You can find the full license text in the repository - [Full MIT license text](https://github.com/hueristiq/xtee/blob/master/LICENSE).
## Credits
### Contributors
A huge thanks to all the contributors who have helped make `xtee` what it is today!
[](https://github.com/hueristiq/xtee/graphs/contributors)
### Similar Projects
If you're interested in more utilities like this, check out:
[tomnomnom/anew](https://github.com/tomnomnom/anew) ◇ [rwese/anew](https://github.com/rwese/anew) ◇ tee (coreutils) ◇ sponge (moreutils)