{"id":15934626,"url":"https://github.com/keinos/whereami","last_synced_at":"2026-02-16T10:40:39.343Z","repository":{"id":43070283,"uuid":"464463399","full_name":"KEINOS/whereami","owner":"KEINOS","description":"Simple command line utility that prints the current global/public/dynamic IP address.","archived":false,"fork":false,"pushed_at":"2022-11-14T00:23:34.000Z","size":75,"stargazers_count":4,"open_issues_count":4,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-31T07:01:33.418Z","etag":null,"topics":["cli","dynamic-ip","global-ip","homebrew","ipaddress","ipaddress-tracker","linux","macos","public-ip-address","windows"],"latest_commit_sha":null,"homepage":"","language":"Go","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/KEINOS.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":".github/SECURITY.md","support":null}},"created_at":"2022-02-28T11:56:10.000Z","updated_at":"2024-03-13T16:51:58.000Z","dependencies_parsed_at":"2022-08-20T14:21:18.213Z","dependency_job_id":null,"html_url":"https://github.com/KEINOS/whereami","commit_stats":null,"previous_names":[],"tags_count":9,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KEINOS%2Fwhereami","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KEINOS%2Fwhereami/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KEINOS%2Fwhereami/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KEINOS%2Fwhereami/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/KEINOS","download_url":"https://codeload.github.com/KEINOS/whereami/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252823688,"owners_count":21809708,"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","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":["cli","dynamic-ip","global-ip","homebrew","ipaddress","ipaddress-tracker","linux","macos","public-ip-address","windows"],"created_at":"2024-10-07T03:20:23.311Z","updated_at":"2026-02-16T10:40:39.290Z","avatar_url":"https://github.com/KEINOS.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# WhereAmI\n\n`whereami` is a simple **command line utility that displays your current global/public IP address**; works on macOS, Linux and Windows.\n\nUseful for finding out the ephemeral (current external) IPv4 address.\n\n```shellsession\n$ whereami\n123.234.123.124\n```\n\n```shellsession\n$ whereami -help\nUsage of whereami:\n  -verbose\n        prints detailed information if any. such as IPv6 and etc.\n```\n\n- Note:\n  - This command only displays IPv4 addresses. However, **some service providers will return IPv6 addresses and more detailed information**. In these cases, the `--verbose` option can be used to view the details of the provider's response.\n  - To avoid a large number of API requests to the service providers, **this application sleeps for one second** after printing the obtained global/public IP address.\n\n## Install\n\n- Manual download and install:\n  - [Latest Releases Page](https://github.com/KEINOS/whereami/releases/latest)\n    - **macOS** (x86_64/M1), **Windows** (x86_64/ARM64), **Linux** (x86_64/ARM64/ARM v5, 6, 7)\n    - Download the archive of your OS and architecture then extract it. Place the extracted binary in your PATH with executable permission.\n    - Public Key of the signature: [https://github.com/KEINOS.gpg](https://github.com/KEINOS.gpg)\n\n- Install via [Homebrew](https://brew.sh/):\n  - macOS, Linux and Windows WSL2. (x86_64/ARM64, M1)\n\n    ```bash\n    brew install KEINOS/apps/whereami\n    ```\n\n- Install via `go install`:\n  - Go v1.16 or above.\n\n    ```bash\n    go install github.com/KEINOS/whereami/cmd/whereami@latest\n    ```\n\n- Run via Docker:\n  - Multiarch build for x86_64 (Intel/AMD) and ARM64/M1 architectures.\n\n    ```bash\n    # The image is around 5.5MB in size\n    docker pull keinos/whereami:latest\n    docker run --rm keinos/whereami\n    ```\n\n## Statuses\n\n[![Unit Test (Versions)](https://github.com/KEINOS/whereami/actions/workflows/unit-tests.yml/badge.svg)](https://github.com/KEINOS/whereami/actions/workflows/unit-tests.yml)\n[![Unit Tests (Platform)](https://github.com/KEINOS/whereami/actions/workflows/platform-test.yml/badge.svg)](https://github.com/KEINOS/whereami/actions/workflows/platform-test.yml)\n[![golangci-lint](https://github.com/KEINOS/whereami/actions/workflows/golangci-lint.yml/badge.svg)](https://github.com/KEINOS/whereami/actions/workflows/golangci-lint.yml)\n[![CodeQL](https://github.com/KEINOS/whereami/actions/workflows/codeQL-analysis.yml/badge.svg)](https://github.com/KEINOS/whereami/actions/workflows/codeQL-analysis.yml)\n\n[![codecov](https://codecov.io/gh/KEINOS/whereami/branch/main/graph/badge.svg?token=wwZpJLfm0l)](https://codecov.io/gh/KEINOS/whereami)\n[![Go Report Card](https://goreportcard.com/badge/github.com/KEINOS/dev-go)](https://goreportcard.com/report/github.com/KEINOS/dev-go)\n\n## Contribute\n\n[![go1.16+](https://img.shields.io/badge/Go-1.16+-blue?logo=go)](https://github.com/KEINOS/whereami/actions/workflows/go-versions.yml \"Supported versions\")\n[![Go Reference](https://pkg.go.dev/badge/github.com/KEINOS/whereami.svg)](https://pkg.go.dev/github.com/KEINOS/whereami/ \"View document\")\n\n[![Opened Issues](https://img.shields.io/github/issues/KEINOS/whereami?color=lightblue\u0026logo=github)](https://github.com/KEINOS/whereami/issues \"opened issues\")\n[![PR](https://img.shields.io/github/issues-pr/KEINOS/whereami?color=lightblue\u0026logo=github)](https://github.com/KEINOS/whereami/pulls \"Pull Requests\")\n\n- [GolangCI Lint](https://golangci-lint.run/) rules: [.golangci-lint.yml](https://github.com/KEINOS/whereami/blob/main/.golangci.yml)\n- To run tests in a container:\n  - `docker-compose --file ./.github/docker-compose.yml run v1_17`\n  - This will run the below on Go 1.17:\n    - `go test -cover -race ./...`\n    - `golangci-lint run`\n    - `golint ./...`\n- Branch to PR:\n  - `main`\n  - ( It is recommended that [DraftPR](https://github.blog/2019-02-14-introducing-draft-pull-requests/) be done first to avoid duplication of work )\n\n## License\n\n- [MIT](https://github.com/KEINOS/whereami/blob/main/LICENSE). Copyright: (c) 2021 [KEINOS and the WhereAmI contributors](https://github.com/KEINOS/whereami/graphs/contributors).\n\n## Acknowledgment\n\n### Service Providers Used\n\nWe would like to thank the following service providers that this command uses to discover global/public IP addresses.\n\n- [https://ipinfo.io/](https://ipinfo.io/)\n- [https://inet-ip.info/](https://inet-ip.info/)\n- [http://inetclue.com/](http://inetclue.com/)\n- [https://toolpage.org/](https://en.toolpage.org/tool/ip-address)\n- [https://ipinfo.io/](https://ipinfo.io/)\n\u003c!-- Disabled due to the issue #2 // - [https://whatismyip.com/](https://www.whatismyip.com/) --\u003e\n\n\u003e **This command requests these providers in random order and returns the first IP address with the same response**. As soon as 3 of the same IP address are returned, the command stops and prints that IP address.\n\u003e If you notice that a provider is not working or not responding properly, please [report an issue](https://github.com/KEINOS/whereami/issues).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkeinos%2Fwhereami","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkeinos%2Fwhereami","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkeinos%2Fwhereami/lists"}