88c3c87954
* chore: slight formatting adjustments * feat: use zensical * chore: add uv to mise.toml * docs: update snippets and snippet markers for includes * chore: add prek to mise.toml; run prek * fix: use snippet for changelog instead of symlink Seems Zensical doesn't like symlinks, a snippet gets the same result * chore: remove commented-out code * chore: remove commented-out code; run prek
1.5 KiB
Installation
prek provides multiple installation methods to suit different needs and environments.
Standalone Installer
The standalone installer automatically downloads and installs the correct binary for your platform:
Linux and macOS
--8<-- "README.md:linux-standalone-install"
Windows
--8<-- "README.md:windows-standalone-install"
Package Managers
PyPI
--8<-- "README.md:pypi-install"
Homebrew (macOS/Linux)
--8<-- "README.md:homebrew-install"
mise
--8<-- "README.md:mise-install"
npmjs
--8<-- "README.md:npmjs-install"
Nix
--8<-- "README.md:nix-install"
Conda
--8<-- "README.md:conda-forge-install"
Scoop (Windows)
--8<-- "README.md:scoop-install"
MacPorts (macOS)
--8<-- "README.md:macports-install"
Install from Pre-Built Binaries
--8<-- "README.md:cargo-binstall"
Build from Source
--8<-- "README.md:cargo-install"
Download from GitHub Releases
--8<-- "README.md:pre-built-binaries"
Updating
--8<-- "README.md:self-update"
For other installation methods, follow the same installation steps again.
Shell Completion
prek supports shell completion for Bash, Zsh, Fish, and PowerShell. To install completions:
Bash
COMPLETE=bash prek > /etc/bash_completion.d/prek
Zsh
COMPLETE=zsh prek > "${fpath[1]}/_prek"
Fish
COMPLETE=fish prek > ~/.config/fish/completions/prek.fish
PowerShell
COMPLETE=powershell prek >> $PROFILE