Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Installation

From crates.io

Install the latest published version with Cargo:

cargo install pctx

Verify the installation:

pctx --version
pctx --help

Update an existing installation:

cargo install pctx --force

Uninstall:

cargo uninstall pctx

Build from source

git clone https://github.com/mc-marcocheng/pctx
cd pctx
cargo build --release

The compiled binary will be available at:

target/release/pctx

You can run it directly:

./target/release/pctx --help

Or install it locally from the checkout:

cargo install --path .

Shell completions

Generate completions with:

pctx completions bash
pctx completions zsh
pctx completions fish
pctx completions powershell
pctx completions elvish

Example for Bash:

pctx completions bash > pctx.bash
source pctx.bash

Example for Zsh:

pctx completions zsh > _pctx

Then move _pctx into a directory listed in your $fpath.

Build the documentation locally

If you have mdbook installed:

cd docs
mdbook serve

Then open the local URL printed by mdbook.