Knott Docs

knott is tracked from the Tknott95 crates.io catalog because it is above the 64-download threshold. Current tracked version is 0.1.17, with 265 downloads across 16 versions.

crates.io: https://crates.io/crates/knott

Docs index: https://docs.rs/crate/knott/latest

API docs: https://docs.rs/knott/latest/knott/

Cargo source: https://docs.rs/crate/knott/latest/source/

Keep public site links pointed to crates.io/docs.rs while backend-published formal docs are prepared.

crates.io category: command-line-utilities.

crates.io keywords: archlinux, aur, package-manager, pacman.

docs.rs package facts: 0% documented rustdoc items, source code size 219.48 kB, documentation size 1.2 MB.

docs.rs dependencies: aisling, anyhow, libc, reqwest, serde, serde_json, and tokio.

knott is a fast Rust Arch Linux package helper for pacman repositories and the AUR.

It combines repo/AUR search, provider-aware AUR planning, upfront install menus, journaled repo/AUR upgrades, PKGBUILD printing/clone/update support, and Aisling-powered tqdm progress loaders for batched AUR metadata fetches.

Install local:

cargo install --path . --locked

Install published:

cargo install knott --locked or cargo install knott --version 0.1.17 --locked

Commands:

knott
knott ripgrep
knott -Ss linux headers
knott --aur -Ss shellcheck-bin
knott -S ripgrep
knott -Syu --needed
knott --aur -S shellcheck-bin --dry-run --noconfirm
knott -Si shellcheck-bin
knott -G shellcheck-bin
knott -Gp shellcheck-bin
knott -Qm
knott -Qua --aur
knott --diagnostics.

Interrupted upgrade: rerun knott --resume. If interruption happened during repo/pacman phase, finish sudo pacman -Syu first, then run knott --resume.

Repair path:

knott --repair checks pacman state and resumes safely. knott --abort discards the saved Knott plan without rolling back installed packages.

Keys/mirrors:

knott --keys imports AUR PGP keys from transaction build dirs, updates the Arch keyring, ranks safe HTTPS IPv4 mirrors with reflector, validates mirrorlist entries, then refreshes and upgrades. Country/key arguments are supported, for example knott --keys Germany 432705FACDD40325.

Resource limits include AUR info chunks of 150 names, AUR info cache cap 4096, search cache cap 128, uncached result sets over 2048, PKGBUILD response cap 1 MiB, dependency graph cap 4096, and local pacman desc file cap 1 MiB.

Output safety:

package metadata, search/info output, status lines, errors, prompts, and dry-run commands are sanitized before terminal output
knott -Gp intentionally prints raw PKGBUILD data for redirection/inspection.

Environment: KNOTT_AUR_URL, KNOTT_BUILDDIR, KNOTT_PACMAN, KNOTT_PACMAN_KEY, KNOTT_MAKEPKG, KNOTT_GIT, KNOTT_GPG, KNOTT_REFLECTOR, KNOTT_SUDO, KNOTT_PROGRESS.

Verification:

cargo fmt --check
cargo clippy --all-targets -- -D warnings
cargo test
cargo package
cargo install --path . --locked --root /tmp/knott-install-check --force.