Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ms-jpq/sad
CLI search and replace | Space Age seD
https://github.com/ms-jpq/sad
cli command-line diff editing fzf rust sed terminal tui
Last synced: 3 days ago
JSON representation
CLI search and replace | Space Age seD
- Host: GitHub
- URL: https://github.com/ms-jpq/sad
- Owner: ms-jpq
- License: mit
- Created: 2020-05-09T01:04:12.000Z (over 4 years ago)
- Default Branch: senpai
- Last Pushed: 2024-09-20T22:07:02.000Z (4 months ago)
- Last Synced: 2024-10-29T15:07:52.972Z (3 months ago)
- Topics: cli, command-line, diff, editing, fzf, rust, sed, terminal, tui
- Language: Rust
- Homepage:
- Size: 37.6 MB
- Stars: 1,752
- Watchers: 10
- Forks: 22
- Open Issues: 25
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-for-oneliner - sad - sed replacement written in Rust (Sed Replacement / Open USP Tsukubai)
- awesome-alternatives-in-rust - sad - CLI search and replace | Space Age seD (Applications / System tools)
README
# [SAD!](https://ms-jpq.github.io/sad)
**Space Age seD**
## What does it do?
Basically `sad` is a **Batch File Edit** tool.
It will show you a really nice diff of proposed changes _before_ you commit them.
Unlike `sed`, you can double check before you fat finger your edit.
## Preview (with fzf)
Selectively replace `std` -> `joseph joestar` in the `sad` repo.
You can pick and choose which changes to apply.
You can also choose the clustering factor for changes using `--unified=`. (Same as in GNU diff)
**If you have `delta` installed, try `--pager 'delta -s'` for side by side view**
## Preview (no fzf)
Replace all`'"(\d+)"'` -> `'🌈$1🌈'` in the `chromium` repo.
use `--commit` or `-k` to commit changes all at once.
`-c` is taken because `sad` has to trick `fzf` into thinking it's `bash` :)
## How to use sad?
**with fzf**
```bash
export GIT_PAGER=''
# ^ can be done in your bash/zsh/rc file.
find "$FIND_ARGS" | sad '' ''
```
Note: `--multi` is passed to fzf so you can select multiple files with `Shift+tab`
**without fzf**
```bash
find "$FIND_ARGS" | sad '' '' | highlighter-of-your-choice
```
or
```bash
find "$FIND_ARGS" | sad '' '' --pager=
```
or
```bash
export GIT_PAGER=''
find "$FIND_ARGS" | sad '' ''
```
**gotta go fast**
If you wanna go fast.
- preview to verify you really want the changes.
- run with `--commit`, and redirect `stdout` to a file or `/dev/null`
---
## Requirements
Technically none of these are "required", but they make `sad` so much happier.
If you install the things below, `sad` will automatically use them. It's progressive enhancement!
### Commandline fuzzer
[**fzf**](https://github.com/junegunn/fzf)
`sad` does not come with a UI, it uses `fzf` to perform selection.
### Diff Colorizer
Any `git` compatible colourizer would work. I prefer these two:
[**delta**](https://github.com/dandavison/delta)
`fd | sad | delta`
[**diff-so-fancy**](https://github.com/so-fancy/diff-so-fancy)
`fd | sad | diff-so-fancy | less`
## Environmental Variables
| Name | Function |
| ----------- | -------------------------------------- |
| `GIT_PAGER` | `sad` will use the same pager as `git` |
## Flags
| Name | Function |
| ---------------- | ----------------------------------------- |
| `-f` `--flags` | Regex flags, see below |
| `-k` `--commit` | No preview, write changes to file |
| `-0` `--read0` | Use `\x00` as stdin delimiter |
| `-e` `--exact` | String literal mode |
| `-p` `--pager` | Colourizing program, disable = `never` |
| `--fzf` | Additional Fzf options, disable = `never` |
| `-u` `--unified` | Same as in GNU `diff`, affects hunk size |
## Regex Flags
By default, `sad` uses smartcase, and multiline matching.
For each options, lowercase toggles on and uppercase toggles off.
ie. `i` => on, `I` => off
| Name | Function |
| ---- | ------------------------------------------------------------------------------------ |
| `i` | case insensitive (works for `--exact` mode as well) |
| `m` | multiline: `^` `$` match each line |
| `s` | allow `.` match `\n` |
| `u` | swap the meaning of `*` and `*?` patterns, (normally `*` is lazy and `*?` is greedy) |
| `x` | ignore whitespace and allow `#` comments |
## Exit Codes
| Code | Meaning |
| ----- | ---------------------------------------------------------------------------------------------------------------------- |
| `0` | Good |
| `1` | Bad |
| `130` | Interrupted (ie. user cancel), or if using `fzf`, [it will always exit `130`](https://github.com/ms-jpq/sad/issues/5). |
## GET SAD NOW!
For scripting, use the following format:
```bash
# replace `x86_64-unknown-linux-gnu.deb` with your desired package
wget 'https://github.com/ms-jpq/sad/releases/latest/download/x86_64-unknown-linux-gnu.deb'
```
### Homebrew:
```bash
brew install sad
```
### Scoop:
```bash
scoop install sad
```
### Snap Store:
coming soon...
### Distribution packages:
##### Debian/Ubuntu:
You can download `sad` deb packages from the [github release page](https://github.com/ms-jpq/sad/releases/latest).
##### Arch Linux:
There is an official Arch Linux package that can be installed via `pacman`:
```
pacman -Syu sad
```
##### Other:
Missing a package for your favourite distribution? Let us know!
### Compile from source:
##### Requirements:
To compile sad yourself you'll have to make sure you have
[Rust](https://www.rust-lang.org/) and `cargo` installed.
##### Install instructions:
To install cargo from source you can run the following commands:
```bash
cargo install --locked --all-features \
--git https://github.com/ms-jpq/sad --branch senpai
```
If you want to install it in a specific directory you can provide the `--root`
flag, like so:
```bash
cargo install --locked --all-features --root="/usr/bin/" \
--git https://github.com/ms-jpq/sad --branch senpai
```
## What about stdin -> stdout
If you just want to edit the shell stream, I would recommend [`sd`](https://github.com/chmln/sd), it uses the same concept, but its more for in stream edits. `sad` was inspired by my initial usage of `sd`.
```bash
command1 | sd '' '' | command2
```
[`ripgrep`](https://github.com/BurntSushi/ripgrep) with `--replace` also works
```bash
command1 | rg --passthru --replace '' -- '' | command2
```
Take note however, `rg` will `exit 1`, it it finds no matches.
## Thank yous
Special thanks to [MadeOfMagicAndWires](https://github.com/MadeOfMagicAndWires) for their generous contribution for maintaining the AUR package.
## Bugs
Please file an issue if you see one `<3`