Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bswck/pick
A simple line picker CLI tool written in Rust. 🦀
https://github.com/bswck/pick
Last synced: 23 days ago
JSON representation
A simple line picker CLI tool written in Rust. 🦀
- Host: GitHub
- URL: https://github.com/bswck/pick
- Owner: bswck
- License: gpl-3.0
- Created: 2024-01-01T22:46:48.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2024-02-17T22:07:48.000Z (9 months ago)
- Last Synced: 2024-02-17T23:21:20.835Z (9 months ago)
- Language: Rust
- Size: 30.3 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# pick
A simple line picker CLI tool written in Rust. 🦀
> [!Warning]
> 🚧 This project is currently in the **Work in Progress** state. 🚧
>
> Hit the `👁 Watch` button to know when it's ready to be tried out!
# Tutorial
Let's consider a simple file `foobar.txt`:
https://github.com/bswck/pick/blob/a2269a78f299fe5cbc4e743422cfcd03cbc5f0f6/assets/foobar.txt#L1-L5
`pick` enables you to manipulate the stream of data and pick lines and characters of interest.
Lines and characters are counted from `1`. An alternative implementation that counts from `0` will be available as `pick0`.
In the further part of this document, you will see sections like this:
> [!Note]
> **Meaning**: _Explanation..._
They are there to help you understand what the prompts above these sections are supposed to do.
## Line Selection
### Single Line Selection
```shell
💲 cat foobar.txt | pick 1
```
> [!Note]
> **Meaning**: _Pick the first line from the `cat foobar.txt` output._
Output:
https://github.com/bswck/pick/blob/a2269a78f299fe5cbc4e743422cfcd03cbc5f0f6/assets/foobar.txt#L1
### Multiple Line Selection
Lines picked with `pick` are separated by the newline character (`\n`) by default:
```shell
💲 cat foobar.txt | pick 1,2
```
> [!Note]
> **Meaning**: _Pick lines 1 and 2 from the `cat foobar.txt` output and connect them with a newline character._
Output:
https://github.com/bswck/pick/blob/a2269a78f299fe5cbc4e743422cfcd03cbc5f0f6/assets/foobar.txt#L1-L2
You can specify a separator for the selected lines:
```shell
💲 cat foobar.txt | pick 1,2 --sep=" "
```
> [!Note]
> **Meaning**: _Pick lines 1 and 2 from the `cat foobar.txt` output and connect them with a space character ` `_.
Output:
```
123456789 foo
```
This saves you from using `xargs` on the `pick` command output.
### Slicing
https://github.com/bswck/pick/blob/a2269a78f299fe5cbc4e743422cfcd03cbc5f0f6/assets/foobar.txt#L1-L5
Slicing syntax in `pick` is similar to the Rust range syntax.
It is left-inclusive and right-exclusive by default.
Slices can generally be expressed in the following pseudo-pattern:
```
START..[=]STOPsSTEP
```
#### Slice Creation Examples
- `1..2`
Every line from 1 to 2 right-exclusive.
**Selects only line 1**.
- `1..5s2`
Every second line from 1 to 5 right-exclusive (starts from the first specified line, `1`, not `3`).
**Selects only lines 1, 3**.
- `1..=5s2`
Every second line from 1 to 5 right-inclusive (starts from the first specified line, `1`, not `3`).
**Selects only lines 1, 3, 5**.
- `1..-1`
Every line from the first character to the last one right-exclusive.
**Selects only lines 1, 2, 3, 4**.
- `1..=-1`
Every line from the first character to the last one right-inclusive.
**Selects lines 1, 2, 3, 4, 5**.
- `1..-1s3`
Every third line from the first character to the last one right-exclusive (starts from the first specified line, `1`, not `4`).
**Selects only lines 1, 4**.
Due to the nature of shells, you can use variables when creating your slices:
```shell
START_IDX=1
END_IDX=5
cat foobar.txt | pick $START_IDX..-1
```
> [!Note]
> **Meaning**:
> - _Globally set `START_IDX` variable to `1` and `END_IDX` to `5`._
> - _Pick lines from 1 to 5 (`-1` in this context means the last line of the output) right-exclusive from the `cat foobar.txt` output._
https://github.com/bswck/pick/blob/a2269a78f299fe5cbc4e743422cfcd03cbc5f0f6/assets/foobar.txt#L1-L4
#### Slice Usage Examples
```shell
💲 cat foobar.txt | pick 1..5
```
> [!Note]
> **Meaning**: _Pick lines from 1 to 5 right-exclusive from the `cat foobar.txt` output and connect them with a space character `\n`._
Output:
https://github.com/bswck/pick/blob/a2269a78f299fe5cbc4e743422cfcd03cbc5f0f6/assets/foobar.txt#L1-L4
You can make your slice right-inclusive with the `=` character before the stop:
```shell
💲 cat foobar.txt | pick 1..=5
```
> [!Note]
> **Meaning**: _Pick lines from 1 to 5 right-inclusive from the `cat foobar.txt` output and connect them with a space character `\n`._
Output:
https://github.com/bswck/pick/blob/a2269a78f299fe5cbc4e743422cfcd03cbc5f0f6/assets/foobar.txt#L1-L5
## Character Selection
More to come here later.