{"id":33338520,"url":"https://github.com/jmatth11/plunder","last_synced_at":"2026-06-09T18:31:26.032Z","repository":{"id":325033759,"uuid":"1099558101","full_name":"jmatth11/plunder","owner":"jmatth11","description":"TUI and library to read/write memory from running process and show basic network info","archived":false,"fork":false,"pushed_at":"2026-01-29T07:31:49.000Z","size":131,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-01-29T09:53:58.688Z","etag":null,"topics":["memory","process","zig"],"latest_commit_sha":null,"homepage":"","language":"Zig","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jmatth11.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-11-19T06:30:06.000Z","updated_at":"2026-01-29T07:31:52.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/jmatth11/plunder","commit_stats":null,"previous_names":["jmatth11/plunder"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/jmatth11/plunder","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jmatth11%2Fplunder","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jmatth11%2Fplunder/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jmatth11%2Fplunder/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jmatth11%2Fplunder/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jmatth11","download_url":"https://codeload.github.com/jmatth11/plunder/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jmatth11%2Fplunder/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":34121021,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-09T02:00:06.510Z","response_time":63,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["memory","process","zig"],"created_at":"2025-11-21T09:00:31.797Z","updated_at":"2026-06-09T18:31:26.023Z","avatar_url":"https://github.com/jmatth11.png","language":"Zig","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Plunder\n\n![Plunder Edit View](./references/pictures/edit-view.png)\n\nContents:\n- [TUI Demo](#tui-demo)\n- [Functionality](#functionality)\n    - [Library Features](#library-features)\n    - [TUI Features](#tui-features)\n- [Build](#build)\n    - [TUI](#tui)\n    - [Library](#library)\n- [Example](#example)\n- [Docs](#docs)\n- [Testing](#testing)\n\n\u003e [!WARNING]\n\u003e This library is still in the early stages and the API may change.\n\nPlunder allows you read/write memory from a running process on linux and grab basic network information.\n\nThis repo is a library and a TUI.\n\n## TUI Demo\n\nhttps://github.com/user-attachments/assets/c55f432a-d45b-4c0f-835a-13b82f1b63f6\n\n## Functionality\n\n### Library Features\n\nCurrent functionality:\n- Read Memory from a given process.\n    - Get the list of region names\n    - Read the raw data from the Region.\n    - Read only populated data from the Region.\n    - Filter regions of memory by scanning all memory between regions for a\n      specified search term.\n- Write to memory to a given process.\n- Read basic network information from a given process.\n    - Read what ports and protocols a process is using.\n\n### TUI Features\n\nMost of the instructions for using the TUI are documented at the top of each\npanel in the TUI itself.\n\nFunctionality list:\n- View all processes currently running on the machine.\n- View memory regions, raw memory within regions, and process info (cmd line args, env args, network info).\n- Filter process list for quickly finding process to view. Filter works on process id and process name.\n- Filter on Memory regions by a text you are searching for in memory.\n- Search through the memory view for a specific text in memory.\n- Edit memory selection in memory view.\n    - Edit in hex or text mode.\n- Refresh process data in TUI.\n\n## Build\n\n### TUI\n\nThe easiest way to build the TUI is like so:\n```bash\n./build.sh\n```\n\nThe build script will check to see if you have the right version of zig installed\nand if so, use that to build the TUI. Otherwise, it will download a temporary Zig\nto use to compile the program then delete the temporary Zig once done.\n\nRun the TUI with:\n```bash\nsudo ./zig-out/bin/plunder\n```\n\n### Library\n\nInclude the library into your project like so.\n\nFetch the library:\n```bash\nzig fetch --save git+https://github.com/jmatth11/plunder#main\n```\n\nAdd this to your `build.zig` file.\n```zig\n    const plunder_dep = b.dependency(\"plunder\", .{\n        .target = target,\n        .optimize = optimize,\n    });\n    exe.root_module.addImport(\"plunder\", plunder_dep.module(\"plunder\");\n```\n\n## Example\n\nSimple reading from a process ID and getting the populated memory from a certain region.\n\n```zig\nconst std = @import(\"std\");\nconst plunder = @import(\"plunder\");\n\npub fn main() !void {\n    const alloc = std.heap.smp_allocator;\n\n    // initialize plunder lib.\n    var pl: plunder.Plunder = .init(alloc);\n    defer pl.deinit();\n\n    // load mapping info for process ID.\n    try pl.load(\u003cpid\u003e);\n\n    // get region names from memory mapping file.\n    const names = try pl.get_region_names(alloc);\n    if (names) |name| {\n        for (name.items) |entry| {\n            // operate on names\n        }\n    }\n\n    // get region data for the heap region.\n    const reg_opt = try pl.get_region_data(\n        \"[heap]\",\n    );\n\n    if (reg_opt) |*region_ptr| {\n        var region = region_ptr.*;\n        defer region.deinit();\n\n        // get the non-zero data from the region in a memory list.\n        const mem = try region.get_populated_memory(alloc);\n        defer mem.deinit();\n        for (mem.items) |*memory_ptr| {\n            var memory = memory_ptr.*;\n            defer memory.deinit();\n            for (memory.buffer.?) |c| {\n                // operate on buffer data.\n            }\n        }\n    }\n}\n```\n\nYou can also look at `test/heap_read.zig` to see an example of overwriting memory.\n\n## Docs\n\nTo view the docs for the repo you need to generate them with this command:\n```bash\nzig build docs\n```\n\nThis will generate the docs in `zig-out/docs`.\nNext serve this director to view them. The easiest way is with python or python3.\n\n```bash\npython3 -m http.server 8000 -d zig-out/docs/\n```\n\nNavigate to `http://localhost:8000`. Now you can navigate the docs.\n\n## Testing\n\nThe folder `test` contains a simple example of testing against a C program\nthat allocates memory on the heap.\n\nThe `heap_read.zig` file accepts the process ID to read from and searches for\nthe test text that is allocated in the `dummy.c` file.\n\nYou can run this test with the `run_test.sh` script at the top of the repo.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjmatth11%2Fplunder","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjmatth11%2Fplunder","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjmatth11%2Fplunder/lists"}