procs is a replacement for ps
written in Rust.
Documentation quick links
Features
- Colored and human-readable output
- Automatic theme detection based on terminal background
- Multi-column keyword search
- Some additional information which are not supported by
ps
- TCP/UDP port
- Read/Write throughput
- Docker container name
- More memory information
- Pager support
- Watch mode (like
top
) - Tree view
Platform
- Linux is supported.
- macOS is experimentally supported.
- macOS version is checked on Travis CI environment only.
- The issues caused by real-machine are welcome.
- Windows is supported.
Installation
Download binary
Download from release page, and extract to the directory in PATH.
Nixpkgs
You can install from Nixpkgs.
snapcraft
You can install from snapcraft.
homebrew
You can install from homebrew.
MacPorts
You can install from MacPorts.
Alpine Linux
You can install from the Alpine Linux repository.
The correct repository (see above link for the most up-to-date information) should be enabled before apk add
.
Arch Linux
You can install from the Arch Linux community repository.
Scoop
You can install with scoop.
Fedora
RPM
You can install with rpm.
sudo rpm -i https://github.com/dalance/procs/releases/download/v0.14.0/procs-0.14.0-1.x86_64.rpm
Cargo
You can install with cargo.
Installation Notes
Permissions issues
On macOS, normal users can’t access any information on other users’ processes.
On Linux, normal users can’t access some information (ex. Read/Write throughput) of other users.
If you want to show this information, you should use sudo
.
$ sudo procs [sudo] password for ...:
If you want to skip password input, you can add the following entry to /etc/sudoers
.
[user or group] ALL= NOPASSWD: [procs binary path]
// ex. myuser ALL= NOPASSWD: /usr/local/bin/procs
Usage
In the following screenshots, config/large.toml
is used as the configuration.
Show all processes
Type procs
only. It shows the information of all processes.
Search by non-numeric keyword
If you add any keyword as argument, it is matched to USER
, Command
by default.
If you want to add columns matching to non-numeric keyword, nonnumeric_search
option can be used in configuration file.
Search by numeric keyword
If a numeric is used as the keyword, it is matched to PID
by default.
Numeric is treated as exact match, and non-numeric is treated as partial match by default.
procs --or 6000 60000 60001 16723
If you want to add columns matching to numeric keyword, numeric_search
option can be used in configuration file.
Note that procfs permissions only allow identifying listening ports for processes owned by the current user, so not all ports will show up unless run as root.
Logical operation of search keywords
If there are some keywords, logical operation between the keywords can be specified by commandline option.
--and
: The processes that match with all keywords are shown.--or
: The processes that match with any keyword are shown.--nand
: The processes are shown unless these match with all keywords.--nor
: The processes are shown unless these match with any keyword.
The default operation can be specified in the configuration file. See [search]
section.
Show Docker container name
If you have access permission to docker daemon ( unix:///var/run/docker.sock
), Docker
column is added.
Note that procs gets the container information through UNIX domain socket, so Docker Toolbox on macOS (doesn’t use UNIX domain socket) is not supported.
Docker Desktop for Mac is supported but not tested.
Pager
If output lines exceed terminal height, pager is used automatically.
This behavior and pager command can be specified by configuration file.
Linux / macOS
On Linux and macOS, less
is the default pager.
If there is not less
, more
is used.
Instead of them, built-in pager can be used by configuration use_builtin
.
Windows
On Windows, built-in pager is always used.
Watch mode
If --watch
or --watch-interval
option is used, procs automatically updates output like top
.
If --watch
is used, the update interval becomes 1s.
The update interval can be specified by the argument of --watch-interval
.
There are some keyboard shortcuts to control.
n
: Change the sort column to the next columnp
: Change the sort column to the previous columna
: Change the sort order to ascendingd
: Change the sort order to descendingq
: Quit
Tree view
If --tree
option is used, processes are sorted by dependency order and dependency tree is shown at left side.
If TreeSlot
column exists in config, dependency tree is shown at the slot.
Sort column
Column sort order can be changed by --sorta
or --sortd
option.
The last character of --sorta
and --sortd
means sort order: “a”scending and “d”escending.
The column for sort is selected by the option keyword.
The keyword is matched with column kind that is shown by --list
option.
If --sorta cputime
, column is sorted by CpuTime
with ascending order.
If --sortd rss
, column is sorted by VmRss
with descending order.
The keyword is matched partially and case is ignored.
The default sort is specified by [sort]
section in the configuration file.
Insert column
--insert
option inserts new column to the position of Slot
column or MultiSlot
column.
The column for insert is selected by the option keyword.
The keyword is the same as sort option.
A Slot
column can be used by an inserted column.
If many insertions are required, many Slot
columns should be added.
A MultiSlot
column can be used by many inserted columns.
If there is a MultiSlot
, all the remaining columns are inserted to the MultiSlot
, and the subsequent Slot
/ MultiSlot
is not used.
Unused Slot
/ MultiSlot
is not shown.
Shell completion
--gen-completion
option generates shell completion files under the current directory.
The following shells are supported.
zsh
bash
fish
powershell
elvish
--gen-completion-out
option generates shell completion to stdout.
You can source it directly on some shells.
source <(procs --gen-completion-out bash)
Configuration
Configuration path
Yo