docs.rs failed to build procinsh-0.1.2
Please check the build logs for more information.
See Builds for ideas on how to fix a failed build, or Metadata for how to configure docs.rs builds.
If you believe this is docs.rs' fault, open an issue.

ProcInSh - Process in the Shell

A web-based process inspector for Linux. Like Ghost in the Shell, you can wander through process space with your ghost.

Now, where shall I go? The process space is vast.

Screenshot

Screenshot of space view

screenmovie.webm

Usage

Requires Linux x86-64. Both installation methods compile native code and require Rust, a C compiler, clang with the BPF backend, bpftool, pkg-config, libelf and zlib development files, and BTF information at /sys/kernel/btf/vmlinux.

Install from crates.io

Install procinsh from crates.io and run it:

(Sorry, we assume you are using Ubuntu, please reinterpret not so)

sudo apt-get install --yes --no-install-recommends \
         build-essential clang llvm pkg-config libelf-dev zlib1g-dev python3 \
         linux-tools-common linux-tools-generic
cargo install procinsh --locked
sudo "$HOME/.cargo/bin/procinsh" --listen 127.0.0.1:9090

The command above uses Cargo's default installation directory. If you use a custom CARGO_HOME or install prefix, adjust the binary path accordingly.

Self build

Also requires Node.js 22 or newer with npm and Rust via rustup. The Rust version and components are pinned in rust-toolchain.toml; rustup installs them automatically when needed.

Clone this repository and run the following from its root:

sudo apt-get install --yes --no-install-recommends \
         build-essential clang llvm pkg-config libelf-dev zlib1g-dev python3 \
         linux-tools-common linux-tools-generic
npm ci
npm run build:web
cargo build --release --locked

The web UI is compiled and embedded into the binary. Node.js and npm are not needed at runtime. Start the release binary:

sudo ./target/release/procinsh --listen 127.0.0.1:9090

Open the UI