3 releases

0.1.2 Jun 2, 2024
0.1.1 May 30, 2024
0.1.0 May 25, 2024

#74 in Text processing

Download history 177/week @ 2024-05-22 457/week @ 2024-05-29 47/week @ 2024-06-05 15/week @ 2024-06-12 1/week @ 2024-06-19

71 downloads per month

MIT license

37KB
842 lines

sig

ci

Interactive grep

sig.gif sig_archived.gif

Features

  • Interactive grep (for streaming)
    • sig allows users to interactively search through (streaming) data, updating results in real-time.
  • Re-execute command
    • If --cmd is specified instread of piping data to sig, the command will be executed on initial and retries.
    • This feature is designed to address the issue where data streams past while the user is fine-tuning the search criteria. In other words, even if the data has already passed, executing the command again allows the retrieval of the data for re-evaluation.
  • Archived mode
    • In archived mode, since there is no seeking capability for streaming data received through a pipe, it is not possible to search backwards without exiting the process. Therefore, in sig, the latest N entries of streaming data are saved, and it is possible to switch to a mode where you can grep through these N entries based on key inputs at any given moment.
    • Additionally, by starting in this mode, it is also possible to grep through static data such as files.
      • like ugrep with -Q option.

Installation

Homebrew

brew install ynqa/tap/sigrs

Cargo

cargo install sigrs

Nix (flakes)

Add it as an input to your flake:

inputs = {
  sig.url = 'github:ynqa/sig/<optional-ref>'
}

Create a shell with it:

nix shell github:ynqa/sig

Or run it directly:

cat README.md | nix run github:ynqa/sig -- --archived

Nix (classic)

Fetch the source and use it, e.g. in your shell:

let
  # At the time of writing this, pkgs need to be unstable for the package to build properly
  # (requires Rust 1.74, stable has 1.73)
  pkgs = import <nixpkgs-unstable> {};

  sig = pkgs.callPackage (pkgs.fetchFromGitHub {
    owner = "ynqa";
    repo = "sig";
    rev = "<revision, e.g. master/v0.1.0/etc.>";
    hash = ""; # Build first, put proper hash in place
  }) {};
in
  pkgs.mkShell {
    packages = [sig];
  }

Examples

stern --context kind-kind etcd |& sig
# or
sig --cmd "stern --context kind-kind etcd" # this is able to retry command by ctrl+r.

Archived mode

cat README.md |& sig -a
# or
sig -a --cmd "cat README.md"

Keymap

Key Action
Ctrl + C Exit sig
Ctrl + R Retry command if --cmd is specified
Ctrl + F Enter Archived mode
Move the cursor one character to the left
Move the cursor one character to the right
Ctrl + A Move the cursor to the start of the filter
Ctrl + E Move the cursor to the end of the filter
Backspace Delete a character of filter at the cursor position
Ctrl + U Delete all characters of filter

(Archived mode)

Key Action
Ctrl + C Exit Archived mode
Move the cursor one character to the left
Move the cursor one character to the right
Ctrl + A Move the cursor to the start of the filter
Ctrl + E Move the cursor to the end of the filter
Backspace Delete a character of filter at the cursor position
Ctrl + U Delete all characters of filter

Usage

Interactive grep (for streaming)

Usage: sig [OPTIONS]

Examples:

$ stern --context kind-kind etcd |& sig
Or the method to retry command by pressing ctrl+r:
$ sig --cmd "stern --context kind-kind etcd"

Archived mode:
$ cat README.md |& sig -a
Or
$ sig -a --cmd "cat README.md"

Options:
      --retrieval-timeout <RETRIEVAL_TIMEOUT_MILLIS>
          Timeout to read a next line from the stream in milliseconds. [default: 10]
      --render-interval <RENDER_INTERVAL_MILLIS>
          Interval to render a line in milliseconds. [default: 10]
  -q, --queue-capacity <QUEUE_CAPACITY>
          Queue capacity to store lines. [default: 1000]
  -a, --archived
          Archived mode to grep through static data.
  -i, --ignore-case
          Case insensitive search.
      --cmd <CMD>
          Command to execute on initial and retries.
  -h, --help
          Print help (see more with '--help')
  -V, --version
          Print version

Dependencies

~16–28MB
~444K SLoC