{"id":22801717,"url":"https://github.com/pojntfx/invaentory","last_synced_at":"2025-08-10T02:31:54.909Z","repository":{"id":57650700,"uuid":"448129871","full_name":"pojntfx/invaentory","owner":"pojntfx","description":"Quickly find all IPv6 and IPv4 hosts in a LAN.","archived":true,"fork":false,"pushed_at":"2023-09-13T00:09:53.000Z","size":38,"stargazers_count":7,"open_issues_count":1,"forks_count":3,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-02-16T23:28:27.683Z","etag":null,"topics":["discovery","ipv6","lan","multicast","network-scanner","ping"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/pojntfx.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}},"created_at":"2022-01-14T22:59:53.000Z","updated_at":"2024-07-12T03:19:48.000Z","dependencies_parsed_at":"2023-09-24T02:32:48.435Z","dependency_job_id":null,"html_url":"https://github.com/pojntfx/invaentory","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"purl":"pkg:github/pojntfx/invaentory","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pojntfx%2Finvaentory","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pojntfx%2Finvaentory/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pojntfx%2Finvaentory/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pojntfx%2Finvaentory/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/pojntfx","download_url":"https://codeload.github.com/pojntfx/invaentory/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pojntfx%2Finvaentory/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":269666713,"owners_count":24456421,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-08-10T02:00:08.965Z","response_time":71,"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":["discovery","ipv6","lan","multicast","network-scanner","ping"],"created_at":"2024-12-12T08:12:37.577Z","updated_at":"2025-08-10T02:31:54.625Z","avatar_url":"https://github.com/pojntfx.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# invaentory\n\nQuickly find all IPv6 and IPv4 hosts in a LAN.\n\n[![hydrun CI](https://github.com/pojntfx/invaentory/actions/workflows/hydrun.yaml/badge.svg)](https://github.com/pojntfx/invaentory/actions/workflows/hydrun.yaml)\n[![Go Reference](https://pkg.go.dev/badge/github.com/pojntfx/invaentory.svg)](https://pkg.go.dev/github.com/pojntfx/invaentory)\n[![Matrix](https://img.shields.io/matrix/invaentory:matrix.org)](https://matrix.to/#/#invaentory:matrix.org?via=matrix.org)\n[![Binary Downloads](https://img.shields.io/github/downloads/pojntfx/invaentory/total?label=binary%20downloads)](https://github.com/pojntfx/invaentory/releases)\n\n## Overview\n\n`invaentory` is a very fast IPv6 and IPv4 LAN scanner, with the intention of allowing the user to quickly take inventory of hosts on their network.\n\n## Installation\n\nStatic binaries are available on [GitHub releases](https://github.com/pojntfx/invaentory/releases).\n\nOn Linux, you can install them like so:\n\n```shell\n$ curl -L -o /tmp/invaentory \"https://github.com/pojntfx/invaentory/releases/latest/download/invaentory.linux-$(uname -m)\"\n$ sudo install /tmp/invaentory /usr/local/bin\n$ sudo setcap cap_net_raw+ep /usr/local/bin/invaentory # This allows rootless execution\n```\n\nOn macOS, you can use the following:\n\n```shell\n$ curl -L -o /tmp/invaentory \"https://github.com/pojntfx/invaentory/releases/latest/download/invaentory.darwin-$(uname -m)\"\n$ sudo install /tmp/invaentory /usr/local/bin\n```\n\nOn Windows, the following should work (using PowerShell as administrator):\n\n```shell\nPS\u003e Invoke-WebRequest https://github.com/pojntfx/invaentory/releases/latest/download/invaentory.windows-x86_64.exe -OutFile \\Windows\\System32\\invaentory.exe\n```\n\nYou can find binaries for more operating systems and architectures on [GitHub releases](https://github.com/pojntfx/invaentory/releases).\n\n## Usage\n\nTo take inventory of all the IPv6 and IPv4 hosts in your LAN, simply run `invaentory`. Note that while Linux allows for rootless execution, macOS requires the use of `sudo` and Windows the use of PowerShell as administrator:\n\n```shell\n$ invaentory\n172.17.0.1\nPinging   7% [\u003e                           ] (4612/65553, 200 host/s) [23s:5m4s]\n```\n\nOnce the scan is finished, all found hosts will be listed:\n\n```shell\n$ invaentory\n172.17.0.1\n100.64.154.241\n2001:7c7:2121:8d00:40e3:c0ea:d71c:db75\n100.64.154.242\n2001:7c7:2121:8d00:da47:32ff:fec9:62a0\n100.64.154.244\n2001:7c7:2121:8d00::3\n100.64.154.243\nfe80::b2a8:6eff:fe0c:ed1a%enp0s13f0u1u2u2\n100.64.154.254\n100.64.154.246\n100.64.154.250\n2001:7c7:2121:8d00:8c77:a50a:e3a9:d284\n100.64.154.250\n2001:7c7:2121:8d00:d125:4d82:b9f7:5a00\n100.64.154.247\n```\n\nIt is also possible to exclude certain IPs by supplying a regular expression to `--exclude`:\n\n```shell\n$ invaentory --exclude '100..*'\n172.17.0.1\n2001:7c7:2121:8d00:40e3:c0ea:d71c:db75\n2001:7c7:2121:8d00:da47:32ff:fec9:62a0\n2001:7c7:2121:8d00::3\nfe80::b2a8:6eff:fe0c:ed1a%enp0s13f0u1u2u2\n2001:7c7:2121:8d00:8c77:a50a:e3a9:d284\n2001:7c7:2121:8d00:d125:4d82:b9f7:5a00\n```\n\nThe progress bar and logging output is written to `STDERR`, so you can further process just the IP addresses as usual, for example to scan all the IPv6 nodes using `nmap`:\n\n```shell\n$ for host in $(invaentory -4=false); do nmap -6 ${host}; done\nStarting Nmap 7.91 ( https://nmap.org ) at 2022-01-15 02:42 CET\nNmap scan report for felicias-xps13 (2001:7c7:2121:8d00:40e3:c0ea:d71c:db75)\nHost is up (0.000089s latency).\nNot shown: 999 closed ports\nPORT   STATE SERVICE\n80/tcp open  http\n\nNmap done: 1 IP address (1 host up) scanned in 0.09 seconds\nStarting Nmap 7.91 ( https://nmap.org ) at 2022-01-15 02:42 CET\nNmap scan report for felicitass-proton.user.selfnet.de (2001:7c7:2121:8d00:da47:32ff:fec9:62a0)\nHost is up (0.00027s latency).\nNot shown: 996 closed ports\nPORT     STATE SERVICE\n22/tcp   open  ssh\n80/tcp   open  http\n443/tcp  open  https\n9090/tcp open  zeus-admin\n\nNmap done: 1 IP address (1 host up) scanned in 0.08 seconds\nStarting Nmap 7.91 ( https://nmap.org ) at 2022-01-15 02:42 CET\n# ...\n```\n\n🚀 **That's it!** You can now take inventory of your network.\n\nBe sure to check out the [reference](#reference) for more information.\n\n## Reference\n\n```bash\n$ invaentory --help\nUsage of invaentory:\n  -4    Ping using ICMPv4 (default true)\n  -6    Ping using ICMPv6 (default true)\n  -exclude string\n        Regex of addresses to exclude\n  -multicast-timeout int\n        Time in milliseconds to wait for responses for multicast (IPv6) pings (default 2000)\n  -parallel int\n        Amount of pings to run in parallel (default 100)\n  -progress\n        Show progress bar on STDERR (default true)\n  -unicast-timeout int\n        Time in milliseconds to wait for responses for unicast (IPv4) pings (default 500)\n  -verbose\n        Enable verbose logging to STDERR\n```\n\n## Acknowledgements\n\n- This project would not have been possible were it not for [@digineo](https://github.com/digineo)'s [go-ping](https://github.com/digineo/go-ping) package; be sure to check it out too!\n\n## Contributing\n\nTo contribute, please use the [GitHub flow](https://guides.github.com/introduction/flow/) and follow our [Code of Conduct](./CODE_OF_CONDUCT.md).\n\nTo build invaentory locally, run:\n\n```shell\n$ git clone https://github.com/pojntfx/invaentory.git\n$ cd invaentory\n$ make depend\n$ make\n$ sudo setcap cap_net_raw+ep out/invaentory\n$ out/invaentory\n```\n\nHave any questions or need help? Chat with us [on Matrix](https://matrix.to/#/#invaentory:matrix.org?via=matrix.org)!\n\n## License\n\ninvaentory (c) 2023 Felicitas Pojtinger and contributors\n\nSPDX-License-Identifier: AGPL-3.0\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpojntfx%2Finvaentory","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpojntfx%2Finvaentory","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpojntfx%2Finvaentory/lists"}