Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/timdp/lwc
A live-updating version of the UNIX wc command.
https://github.com/timdp/lwc
Last synced: 3 months ago
JSON representation
A live-updating version of the UNIX wc command.
- Host: GitHub
- URL: https://github.com/timdp/lwc
- Owner: timdp
- License: mit
- Created: 2018-04-22T09:23:44.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2022-07-26T07:16:55.000Z (over 2 years ago)
- Last Synced: 2024-06-21T15:28:38.221Z (5 months ago)
- Language: Go
- Homepage:
- Size: 1.4 MB
- Stars: 32
- Watchers: 4
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- awesome-go - lwc - A live-updating version of the UNIX wc command. - ★ 5 (Software Packages)
- awesome-go-extra - lwc - updating version of the UNIX wc command.|27|4|0|2018-04-22T09:23:44Z|2022-07-26T07:16:55Z| (Go Tools / DevOps Tools)
README
# lwc
[](https://goreportcard.com/report/github.com/timdp/lwc)
[](https://circleci.com/gh/timdp/lwc)
[](https://coveralls.io/github/timdp/lwc)
[](https://github.com/timdp/lwc/releases/latest)
A live-updating version of the UNIX [`wc` command](https://linux.die.net/man/1/wc).
## Installation
You can get a prebuilt binary for every major platform from the
[Releases page](https://github.com/timdp/lwc/releases). Just extract it
somewhere under your `PATH` and you're good to go.
Alternatively, use `go get` to build from source:
```bash
go get -u github.com/timdp/lwc/cmd/lwc
```
On Debian-compatible Linux distributions such as Ubuntu, you can also use the
_experimental_ APT repository:
```bash
echo 'deb [allow-insecure=yes] https://tmdpw.eu/lwc-releases/debian/ any main' |
sudo tee /etc/apt/sources.list.d/lwc.list
sudo apt update
sudo apt install lwc
```
## Usage
```
lwc [OPTION]... [FILE]...
lwc [OPTION]... --files0-from=F
```
Without any options, `lwc` will count the number of lines, words, and bytes
in standard input, and write them to standard output. Contrary to `wc`, it will
also update standard output while it is still counting.
All the standard [`wc` options](https://linux.die.net/man/1/wc) are
supported:
- `--lines` or `-l`
- `--words` or `-w`
- `--chars` or `-m`
- `--bytes` or `-c`
- `--max-line-length` or `-L`
- `--files0-from=F`
- `--help`
- `--version`
In addition, the output update interval can be configured by passing either
`--interval=TIME` or `-i TIME`, where `TIME` is a duration in milliseconds.
The default update interval is 100 ms.
## Examples
Count the number of lines in a big file:
```bash
lwc --lines big-file
```
Run a slow command and count the number of lines and words logged:
```bash
slow-command | lwc --lines --words
```
Benchmark `lwc`'s throughput by counting random bytes (press Ctrl+C to exit):
```bash
lwc --bytes < /dev/urandom
```
## Caveats
You can _mostly_ use `lwc` as a drop-in replacement for `wc`. However, you
should be aware of the following:
- The behavior of the `--words` and `--chars` options is slightly different
from `wc`'s implementation. You might get different values with certain
binary data.
- While `lwc` is pretty fast, you won't get the same raw throughput as with
`wc`. The reason for that is (probably) twofold: the code isn't optimized for
performance, and a Go implementation is no match for a C one.
## JavaScript Version
This utility briefly existed as a
[Node.js package](https://github.com/timdp/lwc-nodejs). I'm keeping the code
around for educational purposes, but I will no longer be maintaining it.
## Author
[Tim De Pauw](https://tmdpw.eu/)
## License
MIT