klatsche

Crates.ioklatsche
lib.rsklatsche
version1.0.1
sourcesrc
created_at2024-04-11 17:11:49.309857
updated_at2024-04-11 17:21:13.159082
descriptioncli tool to parse and rank known terminal aliases against a given command, intended to be used as a preexec hook for zsh
homepage
repositoryhttps://github.com/JoschuaSchneider/klatsche/
max_upload_size
id1205127
size38,324
Joschua Schneider (JoschuaSchneider)

documentation

README

klatsche

Gives you a ⚡️ blazingly-fast ⚡️ slap on the wrist if you forget to use your terminal aliases.

Usage example

Installation

Prerequisites

  • rust installed
  • zsh installed and configured
  • optional: zimfw setup for use with zmodule

Install from crates.io

cargo install klatsche

Build from source

Clone the repository and run:

cargo build --release

Installing ZSH plugin

Install using zmodule

Add the following to your .zimfw file:

zmodule /Path/to/klatsche --source klatsche.zsh

When building from source, set the KLATSCHE_HOME env variable in your .zshrc file:

KLATSCHE_HOME=/Path/to/klatsche

and then add the following to your .zimfw file:

zmodule /Path/to/klatsche --source klatsche_from_source.zsh

Run zimfw install and restart terminal session.

Restart terminal session.

Usage

Type any long form of an alias, you get a slap in the terminal 🎉

Commit count: 4

cargo fmt