1# Process List Library for Go
2
3[![Build Status](https://travis-ci.org/keybase/go-ps.svg?branch=master)](https://travis-ci.org/keybase/go-ps)
4[![Build Status](https://ci.appveyor.com/api/projects/status/github/keybase/go-ps?branch=master&svg=true)](https://ci.appveyor.com/project/keybase/go-ps)
5[![Coverage Status](https://coveralls.io/repos/github/keybase/go-ps/badge.svg?branch=master)](https://coveralls.io/github/keybase/go-ps?branch=master)
6[![GoDoc](https://godoc.org/github.com/keybase/go-ps?status.svg)](https://godoc.org/github.com/keybase/go-ps)
7
8
9go-ps is a library for Go that implements OS-specific APIs to list and
10manipulate processes in a platform-safe way. The library can find and
11list processes on Linux, Mac OS X, and Windows.
12
13If you're new to Go, this library has a good amount of advanced Go educational
14value as well. It uses some advanced features of Go: build tags, accessing
15DLL methods for Windows, cgo for Darwin, etc.
16
17How it works:
18
19  * **Darwin** uses `sysctl` and `proc_listpids` (for the path) to retrieve the process table, via cgo.
20  * **Unix** uses the procfs at `/proc` to inspect the process tree.
21  * **Windows** uses the Windows API, and methods such as
22    `CreateToolhelp32Snapshot` to get a point-in-time snapshot of
23    the process table.
24
25## Installation
26
27Install using standard `go get`:
28
29```
30$ go get github.com/keybase/go-ps
31```
32