A modern replacement for ps written by Rust
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
img Update README Feb 5, 2019
modified/libproc-rs macOS support (#9) Feb 23, 2019
src macOS support (#9) Feb 23, 2019
.gitignore 1st impl Jan 28, 2019
.travis.yml macOS support (#9) Feb 23, 2019
Cargo.lock Start next development iteration v0.5.1-pre Feb 23, 2019
Cargo.toml Start next development iteration v0.5.1-pre Feb 23, 2019
LICENSE Initial commit Jan 28, 2019
Makefile Fix cargo test Feb 1, 2019
README.md macOS support (#9) Feb 23, 2019

README.md

procs

procs is a replacement for ps written by Rust.

Build Status Crates.io codecov

Features

  • Output by the colored and human-readable format
  • Keyword search over multi-column
  • Some additional information which are not supported by ps
    • TCP/UDP port
    • Read/Write throughput
    • Docker container name
    • More memory information
  • Pager support

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.

Installation

Download binary

Download from release page, and extract to the directory in PATH.

Cargo

You can install by cargo.

cargo install procs

macOS permission issue

In macOS, normal user can't access the process information of other users. So procs requires SUID as the same as ps command. If you add SUID to procs, do like below:

$ sudo chown root [procs binary path]
$ sudo chmod u+s  [procs binary path]

Usage

Show all processes

Type procs only. It shows the information of all processes.

$ procs

procs

Search by non-numeric keyword

If you add any keyword as argument, it is matched to USER, Command, Docker by default.

$ procs zsh

procs_zsh

Search by numeric keyword

If a numeric is used as the keyword, it is matched to PID, TCP, UDP by default. Numeric is treated as exact match, and non-numeric is treated as partial match by default.

$ procs 6000 60000 60001 16723

procs_port

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.

Show Docker container name

If you have access permission to docker daemon ( unix:///var/run/docker.sock ), Docker column is added.

$ procs growi

procs_docker

Pager

If output lines exceed terminal height, pager is used automatically. This behavior and pager command can be specified by configuration file.

Configuration

You can change configuration by ~/.procs.toml like below. The complete example of ~/.procs.toml can be generated by --config option.

[[columns]]
kind = "Pid"
style = "BrightYellow"
numeric_search = true
nonnumeric_search = false

[[columns]]
kind = "Username"
style = "BrightGreen"
numeric_search = false
nonnumeric_search = true

[style]
header = "BrightWhite"
unit = "BrightWhite"

[style.by_percentage]
color_000 = "BrightBlue"
color_025 = "BrightGreen"
color_050 = "BrightYellow"
color_075 = "BrightRed"
color_100 = "BrightRed"

[style.by_state]
color_d = "BrightRed"
color_r = "BrightGreen"
color_s = "BrightBlue"
color_t = "BrightCyan"
color_z = "BrightMagenta"
color_x = "BrightMagenta"
color_k = "BrightYellow"
color_w = "BrightYellow"
color_p = "BrightYellow"

[style.by_unit]
color_k = "BrightBlue"
color_m = "BrightGreen"
color_g = "BrightYellow"
color_t = "BrightRed"
color_p = "BrightRed"
color_x = "BrightBlue"

[search]
numeric_search = "Exact"
nonnumeric_search = "Partial"

[display]
show_self = false
cut_to_terminal = true
cut_to_pager = false
cut_to_pipe = false
color_mode = "Auto"

[sort]
column = 0
order = "Ascending"

[docker]
path = "unix:///var/run/docker.sock"

[pager]
mode = "Auto"

[[columns]] section

[[columns]] section defines which columns are used. The first [[columns]] is shown at left side, and the last is shown at right side. kind is column type and style is column color. numeric_search and nonnumeric_search mean whether this column can be matched by numeric/non-numeric search keyword. The available list of kind and style is below.

There are some special styles like ByPercentage, ByState, ByUnit. These are the styles for value-aware coloring. For example, if ByUnit is choosen, color can be specified for each unit of value ( like K, M, G,,, ). The colors can be configured in [style.by_unit] section.

kind list

procs kind ps STANDARD FORMAT Description Linux macOS
Command args Command with all arguments o o
ContextSw -not supported- Context switch count o o
CpuTime cputime Cumulative CPU time o o
Docker -not supported- Docker container name o o
Eip eip Instruction pointer o
Esp esp Stack pointer o
Gid egid Group ID o o
GidFs fgid File system group ID o
GidReal rgid Real group ID o o
GidSaved sgid Saved group ID o o
Group egroup Group name o o
GroupFs fgroup File system group name o
GroupReal rgroup Real group name o o
GroupSaved sgroup Saved group name o o
MajFlt maj_flt Major page fault count o o
MinFlt min_flt Minor page fault count o o
Nice ni Nice value o o
Pid pid Process ID o o
Policy policy Scheduling policy o o
Ppid ppid Parent process ID o o
Priority pri Priority o o
Processor psr Currently assigned processor o
ReadBytes -not supported- Read bytes from storage o o
RtPriority rtprio Real-time priority o
Separator -not supported- Show | for column separation o o
ShdPnd pending Pending signal mask for process o
SigBlk blocked Blocked signal mask o
SigCgt caught Caught signal mask o
SigIgn ignored Ignored signal mask o
SigPnd pending Pending signal mask for thread o
StartTime start_time Starting time o o
State s Process State o o
TcpPort -not supported- Bound TCP ports o o
Threads nlwp Thread count o o
Tty tty Controlling TTY o o
UdpPort -not supported- Bound UDP ports o o
Uid euid User ID o o
UidFs fuid File system user ID o
UidReal ruid Real user ID o o
UidSaved suid Saved user ID o o
UsageCpu %cpu CPU utilization o o
UsageMem %mem Memory utilization o o
User euser User name o o
UserFs fuser File system user name o
UserReal ruser Real user name o o
UserSaved suser Saved user name o o
VmData -not supported- Data size o
VmExe trs Text segments size o
VmHwm -not supported- Peak resident set size o
VmLib -not supported- Library code size o
VmLock -not supported- Locked memory size o
VmPeak -not supported- Peak virtual memory size o
VmPin -not supported- Pinned memory size o
VmPte -not supported- Page table entries size o
VmRss rss Resident set size o o
VmSize vsz Physical page size o o
VmStack -not supported- Stack size o
VmSwap -not supported- Swapped-out virtual memory size o
Wchan wchan Process sleeping kernel function o
WriteByte -not supported- Write bytes to storage o o

style list

  • BrightRed
  • BrightGreen
  • BrightYellow
  • BrightBlue
  • BrightMagenta
  • BrightCyan
  • BrightWhite
  • Red
  • Green
  • Yellow
  • Blue
  • Magenta
  • Cyan
  • White
  • ByPercentage
  • ByState
  • ByUnit

[style] section

[style] section defines colors of header and unit line. The available list of color is below.

color list

  • BrightRed
  • BrightGreen
  • BrightYellow
  • BrightBlue
  • BrightMagenta
  • BrightCyan
  • BrightWhite
  • Red
  • Green
  • Yellow
  • Blue
  • Magenta
  • Cyan
  • White

[style.by_*] section

[style.by_*] section defines colors of special styles like ByPercentage, ByState, ByUnit. The available list of color is the same as the list of [style] section.

[search] section

[search] section defines match policy. Policy can be Exact or Partial.

[display] section

[display] section defines option for display. show_self means whether the self ( procs ) process is shown. cut_to_* means whether output lines is truncated upto terminal size. color_mode means the default behavior of output coloring without --color commandline option. This can be Auto, Always or Disable.

[sort] section

[sort] section defines the column used for sort and sort order. If column is 0, value is sorted by left column. order can be Ascending or Descending.

[docker] section

[docker] section defines how to communicate to docker daemon. path means UNIX domain socket to docker daemon.

[pager] section

[pager] section defines the behavior of pager. mode means the default behavior of pager usage without --pager commandline option. This can be Auto, Always or Disable. If Auto, pager is used only when output lines exceed terminal height. Default pager is less -SR ( if less is not found, more -f ), but you can specify pager comand like below:

[pager]
mode = "Auto"
command = "less"

If more is used, -f option is recommended.

[pager]
mode = "Auto"
command = "more -f"