Installation

Install Pitchfork

mise (Recommended)

mise-en-place is the recommended way to install pitchfork:

mise use -g pitchfork

Cargo

Install from crates.io:

cargo install pitchfork-cli

GitHub Releases

Download pre-built binaries from GitHub Releases.

Verify Installation

pitchfork --version

Shell Completion

Pitchfork supports tab completion for bash, zsh, and fish.

TIP

Shell completion requires the usage CLI tool to be installed.

bash

mkdir -p ~/.local/share/bash-completion/completions
pitchfork completion bash > ~/.local/share/bash-completion/completions/pitchfork

zsh

mkdir -p ~/.zfunc
pitchfork completion zsh > ~/.zfunc/_pitchfork
# Add to ~/.zshrc: fpath=(~/.zfunc $fpath)

fish

pitchfork completion fish > ~/.config/fish/completions/pitchfork.fish

Shell Alias (Optional)

For a shorter command, add a pf alias to your shell. Combined with the implicit start shorthand, you can then start a daemon with just pf api:

bash

echo 'alias pf=pitchfork' >> ~/.bashrc

zsh

echo 'alias pf=pitchfork' >> ~/.zshrc

fish

echo 'alias pf pitchfork' >> ~/.config/fish/config.fish

Restart your shell or source the file, then pf api runs pitchfork start api.

What's Next?

• Quick Start - Run your first daemon
• Your First Project - Set up a project with multiple daemons