runproclike 0.2.1

runproclike is a CLI utility that analyzes a running process by its PID and prints the command and its environment in a reproducible form.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97

# runproclike
[![Build](https://github.com/PauloMigAlmeida/runproclike/actions/workflows/rust.yml/badge.svg)](https://github.com/PauloMigAlmeida/runproclike/actions/workflows/rust.yml)
[![Release](https://github.com/PauloMigAlmeida/runproclike/actions/workflows/release.yml/badge.svg)](https://github.com/PauloMigAlmeida/runproclike/actions/workflows/release.yml)
[![Crate](https://img.shields.io/crates/v/runproclike.svg)](https://crates.io/crates/runproclike)

`runproclike` is a lightweight command-line utility that analyzes a running process by its PID and prints the command and its environment in a reproducible form. It's especially useful for debugging, replicating process states, or migrating workloads.

## Features

- Generates a detailed output of the process's environment, command line, and execution context.
- Inspired by the [runlike](https://github.com/lavie/runlike) tool, which focuses on reconstructing Docker commands. `runproclike` extends this concept to Linux processes.

### Example

```bash
runproclike --pid 19352

sudo -i -u \#1000 <<EOF
  # change cwd user to match the target process
  cd /home/paulo/workspace/runproclike
  
  # export env variables to match the target process
  export WAYLAND_DISPLAY='wayland-0'
  export USER='paulo'
  export XDG_MENU_PREFIX='gnome-'
  export LANG='en_NZ.UTF-8'
  
  # cmdline to match the target process
  /bin/bash \
     --rcfile \
    /home/paulo/IDE/RustRover-2024.3.2/plugins/terminal/shell-integrations/bash/bash-integration.bash \
    -i
EOF
```

## Installation

### Using Cargo

```bash
export PATH=~/.cargo/bin/:$PATH
cargo install runproclike
```

### Using Docker
Don't want to build and install anything? All good, you can leverage the docker image
built precisely for that!

```bash
docker run \
  --rm \
  --privileged \
  --pid=host \
  ghcr.io/paulomigalmeida/runproclike:latest \
  --pid <pid>
```

### Building from source
1. Clone the repository:
   ```bash
   git clone https://github.com/PauloMigAlmeida/runproclike.git
   cd runproclike
   ```
2. Build
   ```bash
   cargo build --release
   ```

## Usage

`runproclike [OPTIONS] --pid <PID>`

### Options:

```bash
Usage: runproclike [OPTIONS] --pid <PID>

Options:
  -p, --pid <PID>      PID of the process of interest
      --command-only   print the command line of the process without the path, cwd, env, etc.
      --omit-comments  Omit comments from the output.
  -h, --help           Print help
  -V, --version        Print version
```

## How it Works

`runproclike` inspects a process's details by reading procfs files and outputs the information needed to recreate the process in a shell.

## Contributing

Contributions are welcome! Please follow these steps:

- Fork the repository.
- Create a new branch for your feature/fix.
- Write tests ;)
- Submit a pull request.