{"id":13496697,"url":"https://github.com/eth-p/bat-extras","last_synced_at":"2025-05-14T05:10:38.007Z","repository":{"id":39228997,"uuid":"192805440","full_name":"eth-p/bat-extras","owner":"eth-p","description":"Bash scripts that integrate bat with various command line tools.","archived":false,"fork":false,"pushed_at":"2025-02-22T03:01:42.000Z","size":504,"stargazers_count":1330,"open_issues_count":51,"forks_count":86,"subscribers_count":15,"default_branch":"master","last_synced_at":"2025-05-12T00:48:53.170Z","etag":null,"topics":["bat","hacktoberfest"],"latest_commit_sha":null,"homepage":"","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/eth-p.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2019-06-19T21:15:49.000Z","updated_at":"2025-05-11T05:07:51.000Z","dependencies_parsed_at":"2023-12-13T20:06:38.257Z","dependency_job_id":"266e4011-c4b0-444c-9875-e4e3c862b8e2","html_url":"https://github.com/eth-p/bat-extras","commit_stats":{"total_commits":332,"total_committers":13,"mean_commits":25.53846153846154,"dds":0.06325301204819278,"last_synced_commit":"daf888f5ed697ee69d848f037bf80c84d1261c47"},"previous_names":[],"tags_count":18,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eth-p%2Fbat-extras","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eth-p%2Fbat-extras/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eth-p%2Fbat-extras/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eth-p%2Fbat-extras/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/eth-p","download_url":"https://codeload.github.com/eth-p/bat-extras/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254076849,"owners_count":22010611,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bat","hacktoberfest"],"created_at":"2024-07-31T19:01:57.252Z","updated_at":"2025-05-14T05:10:37.933Z","avatar_url":"https://github.com/eth-p.png","language":"Shell","funding_links":[],"categories":["Shell","Tools/Scripts/Code:","Command Line","Uncategorized","hacktoberfest"],"sub_categories":["Dependency Management"],"readme":"# bat-extras\n\nBash scripts that integrate [bat](https://github.com/sharkdp/bat) with various command line tools.\n\n\u0026nbsp;\n\n## Scripts\n\n### [`batgrep`](doc/batgrep.md)\nQuickly search through and highlight files using [ripgrep](https://github.com/burntsushi/ripgrep).\n\u003cu\u003eRequirements:\u003c/u\u003e `ripgrep`\n\n\n\n### [`batman`](doc/batman.md)\n\nRead system manual pages (`man`) using `bat` as the manual page formatter.\n\n\n\n### [`batpipe`](doc/batpipe.md)\n\nA `less` (and soon `bat`) preprocessor for viewing more types of files in the terminal.\n\n\n\n### [`batwatch`](doc/batwatch.md)\n\nWatch for changes in one or more files, and print them with `bat`.\n\u003cu\u003eRequirements:\u003c/u\u003e `entr` (optional)\n\n\n\n### [`batdiff`](doc/batdiff.md)\nDiff a file against the current git index, or display the diff between two files.\n\u003cu\u003eRequirements:\u003c/u\u003e `bat`, `delta` (optional)\n\n\n\n### [`prettybat`](doc/prettybat.md)\n\nPretty-print source code and highlight it with `bat`.\n\u003cu\u003eRequirements:\u003c/u\u003e (see doc/prettybat.md)\n\n\u0026nbsp;\n\n## Installation via Package Manager\n\n### Homebrew\n\nAll of the `bat-extras` scripts can be installed with `brew install bat-extras`.\n\nIf you would prefer to only install the specific scripts you need, you can use the `eth-p/software` tap to install individual scripts: `brew install eth-p/software/bat-extras-[SCRIPT]`\n\n\n### MacPorts\n\nThe `bat-extras` scripts can also be installed via [MacPorts](https://www.macports.org) on macOS:\n\n```bash\nsudo port install bat-extras\n```\n\nPort info [here](https://ports.macports.org/port/bat-extras/).\n\n### Pacman \n\n`bat-extras` is [officially available](https://archlinux.org/packages/extra/any/bat-extras/) on the Arch extra repository!\n\nIf you have the extra repository enabled, you can install `bat-extras` by running:\n\n```bash\npacman -S bat-extras\n```\n\n### Gentoo\n`bat-extras` is available on **Gentoo's Guru Overlay** as `sys-apps/bat-extras`.\n\nTo install, first make sure you've added the [Gentoo Guru Overlay](https://wiki.gentoo.org/wiki/Project:GURU) to your local repositories, then emerge accordingly...\n\n```bash\nemerge sys-apps/bat-extras\n```\n\n### Fedora (Unofficial)\n`bat-extras` is available in an unofficial Fedora Copr\n[repository](https://copr.fedorainfracloud.org/coprs/awood/bat-extras/).\n**Note**: this package does not contain `prettybat` since `prettier` is not yet\npackaged for Fedora.\n\nInstall the Copr plugin, enable the repository, and then install the package\nby running:\n\n```bash\ndnf install dnf-plugins-core \ndnf copr enable awood/bat-extras\ndnf install bat-extras\n```\n\n\u0026nbsp;\n\n## Installation\n\n[![Test](https://github.com/eth-p/bat-extras/actions/workflows/test.yaml/badge.svg)](https://github.com/eth-p/bat-extras/actions/workflows/test.yaml)\n\nThe scripts in this repository are designed to run as-is, provided that they aren't moved around.\nThis means that you're free to just symlink `src/[script].sh` to your local bin folder.\n\nIf you would rather have *faster*, self-contained scripts that you can place and run anywhere, you can use the `build.sh` script to create (and optionally install) them.\n\n\u0026nbsp;\n\n**Building:**\n\n```bash\n./build.sh [OPTIONS...]\n```\n\nThis will combine and preprocess each script under the `src` directory, and create corresponding self-contained scripts in the `bin` folder. Any library scripts that are sourced using `source \"${LIB}/[NAME].sh\"` will be embedded automatically.\n\n\u0026nbsp;\n\n**Minification:**\n\nThere are three different options for minification:\n\n| Option          | Description                                            |\n| --------------- | ------------------------------------------------------ |\n| `--minify=none` | Nothing will be minified.                              |\n| `--minify=lib`  | Embedded library scripts will be minified. \\[default\\] |\n| `--minify=all`  | Everything will be minified.                           |\n\nThis uses [shfmt](https://github.com/mvdan/sh) to perform minification.\n\n\n\u0026nbsp;\n\n**Installation:**\n\nYou can also specify `--install` and `--prefix=PATH` to have the build script automatically install the scripts for all users on the system. You may need to run the build script as root.\n\nIf you only want to install a single script, you can run the build process and copy the script directly out of the newly-created `bin` folder.\n\n\n\n**Manuals:**\n\nThe build script will automatically generate a `man` page for each of the markdown documentation files.\nThis is a beta feature that uses a non-compliant Markdown \"parser\" written in Bash, and there is no guarantee towards the quality of the generated manual pages. If you do not want to generate manual files, you can provide the `--no-manuals` option to disable manual file generation.\n\n\n\n**Alternate Executable:**\n\nDepending on the distribution, bat may have been renamed to avoid package conflicts.\nIf you wish to use these scripts on a distribution where this is the case, there is an `--alternate-executable=NAME` option which will build the scripts to use an alternate executable name.\n\nYou may also specify alternate executables for `ripgrep`, `delta`, `fzf`, or `git` with `--alternate-executable:PROGRAM NAME` where `PROGRAM` is one the aforementioned programs. Note that doing so may cause verification to fail.\n\n\n**Verification:**\n\nThe build script will attempt to verify the correctness of the \"bin\" scripts by comparing their output with their source counterparts. It is recommended to let it do this, but you can disable verification with the `--no-verify` option.\n\n\u0026nbsp;\n\n## Contributing\n\nIf you would like to contribute to `bat-extras`, please feel free to [open an issue on GitHub](https://github.com/eth-p/bat-extras/issues), or make a pull request. If you do the latter, please keep our [contributing guidelines](./CONTRIBUTING.md) in mind.  \n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Feth-p%2Fbat-extras","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Feth-p%2Fbat-extras","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Feth-p%2Fbat-extras/lists"}