https://github.com/bitpingapp/bping
A command line utility to ping servers from anywhere in the world!
https://github.com/bitpingapp/bping
bitping console devops distributed-computing it ping terminal worldwide
Last synced: 3 months ago
JSON representation
A command line utility to ping servers from anywhere in the world!
- Host: GitHub
- URL: https://github.com/bitpingapp/bping
- Owner: BitpingApp
- Created: 2020-09-13T09:45:37.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2024-12-07T11:27:44.000Z (10 months ago)
- Last Synced: 2025-03-26T08:14:03.702Z (7 months ago)
- Topics: bitping, console, devops, distributed-computing, it, ping, terminal, worldwide
- Language: Rust
- Homepage:
- Size: 428 KB
- Stars: 9
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# bping
## 🚀 Ready to Start Pinging?
1. Head over to [developer.bitping.com](https://developer.bitping.com/pricing) to create your free account
2. Create your API key in the developer dashboard
3. Set the API Key environment variable
- eg. `export BITPING_API_KEY=your_api_key`
With your API key in hand, you'll be ready to ping from anywhere in the world!
## Linux/MacOS Installation
You can install bping directly using this command:
```sh
curl --proto '=https' --tlsv1.2 -LsSf https://github.com/BitpingApp/bping/releases/latest/download/bping-installer.sh | sh
```
#### Install prebuilt binaries via Homebrew
```sh
brew install BitpingApp/tap/bping
```
## Windows Installation
You can install bping on Windows by running this command in PowerShell:
```sh
powershell -ExecutionPolicy ByPass -c "irm https://github.com/BitpingApp/bping/releases/latest/download/bping-installer.ps1 | iex"
```
#### Install using Windows Installer
Go to the latest release and download the .msi for windows.
### Help Documentation
---
```
A command line utility to ping a website from anywhere in the world!
Usage: bping [-r=] [-c=] [-a=] [--concurrency=] --api-key=
[--residential=] [--mobile=] [--proxy=]
Available positional items:
Specifies the endpoint (without http://) to ping. eg. bitping.com
Available options:
-r, --regions= Specifies the ISO 3166-1 country codes (alpha-2 or alpha-2) & continent
names to send jobs to. Defaults to Anywhere.
(eg. bping -r "AU,CHN,North America" bitping.com)
-c, --count= Specifies the number of ICMP packets to send per country. Defaults to
3.
-a, --attempts= Specifies the number of ping attempts per country. Defaults to 1.
--concurrency= Specifies how many concurrent requests to send at once.
Defaults to 100.
--api-key= Specifies the API key for authentication. Can also be set using the
BITPING_API_KEY environment variable.
[env:BITPING_API_KEY: N/A]
--residential= Control residential network usage. --residential=true to
require, --residential=false to deny, omit to allow.
--mobile= Control mobile network usage. --mobile=true to require, --mobile=false
to deny, omit to allow.
--proxy= Control proxy network usage. --proxy=true to require, --proxy=false to
deny, omit to allow.
-h, --help Prints help information
-V, --version Prints version information
```