<h1><img src="logo.svg" width="200" alt="getargv"></h1>
[](https://github.com/getargv/getargv-sys/actions/workflows/rust.yml)
This crate is the Rust bindings for the `libgetargv` library. `libgetargv` is a library that allows you to get the arguments that were passed to another running process on macOS. It is intended to provide roughly the same functionality as reading from `/proc/<pid>/cmdline` on Linux. On macOS this is done by parsing the output of the `KERN_PROCARGS2` sysctl, which is <abbr title="always, in my observation">very often</abbr> implemented [incorrectly](https://getargv.narzt.cam/hallofshame.html), due to the overlooked possibility of leading empty arguments passed to the target process.
## Installation
- Install `libgetargv` to your system (see below).
- Add the crate to your `Cargo.toml` file dependencies:
```toml
[target.'cfg(target_vendor = "apple")'.dependencies]
getargv-sys = "~0.5.6"
```
> [!IMPORTANT]
> You should limit the dependency to just macOS unless your whole project only builds on macOS, as `getargv-sys` will not build on any other OS.
## Permissions
`libgetargv` can only see processes running as the same user by default, so be sure your process runs as the desired user (`setuid`, [`launchd.plist`](x-man-page://launchd.plist), [`sudo`](x-man-page://sudo)) or can [elevate privileges](https://developer.apple.com/library/archive/documentation/Security/Conceptual/SecureCodingGuide/Articles/AccessControl.html).
> [!CAUTION]
> Elevating privileges safely is [extremely complicated](https://developer.apple.com/forums/thread/708765), and will be a target of privilege escalation attacks on macOS so be extremely careful if you go this route, better to defer to the user to elevate privileges for you as needed.
## System Requirements
macOS is required as this is a macOS specific `sysctl`, even BSD does not implement it. Your system must support `sysctl` and `KERN_PROCARGS2`, which probably means macOS [10.3](https://github.com/apple-oss-distributions/xnu/blob/xnu-517/bsd/sys/sysctl.h#L332) or later, though I haven't tested versions older than 10.7. You'll also need a non-ancient clang (c99 is required) or you'll have to override the compiler flags with `CC`, `EXTRA_CPPFLAGS`, and `EXTRA_CFLAGS`.
## Building `getargv-sys`
To make `getargv-sys`:
- Install `libgetargv` to your system (see below).
- Clone this repo and run `cargo build`.
## Installing `libgetargv`
To get access to `libgetargv`, sign up for an appropriate [sponsorship tier](https://github.com/sponsors/CamJN).
Then you will be able to follow the instructions at https://github.com/getargv/getargv to install libgetargv.
