search

jsdelivr / globalping-cli

A simple CLI tool to run networking commands remotely from hundreds of globally distributed servers
Mozilla Public License 2.0
144 stars 13 forks source link

In CLI docs, examples updates #39

Closed didil closed 1 year ago

didil commented 1 year ago

Improves #16

Please let me know if there are any other specific in-cli documentation texts or examples that need to be improved

jimaek commented 1 year ago

Lets group the commands, right now help is between dns and http as if its a measurement command. We should separate the measurement commands and CLI commands like help, completion and later credits and install-probe...

Did you also look into this?

didil commented 1 year ago

Lets group the commands, right now help is between dns and http as if its a measurement command. We should separate the measurement commands and CLI commands like help, completion and later credits and install-probe...

Did you also look into this?

@jimaek this is the current output of "globalping-cli --help" :

Globalping is a platform that allows anyone to run networking commands such as ping, traceroute, dig and mtr on probes distributed all around the world.
The CLI tool allows you to interact with the API in a simple and human-friendly way to debug networking issues like anycast routing and script automated tests and benchmarks.

Usage:
  globalping [command]

Measurement Commands:
  dns         Use the native dig command
  http        Perform a HEAD or GET request to a host
  mtr         Use the native mtr command
  ping        Use the native ping command
  traceroute  Use the native traceroute command

Additional Commands:
  completion  Generate the autocompletion script for the specified shell
  help        Help about any command
  version     Print the version number of Globalping CLI

Flags:
  -C, --ci            Disable realtime terminal updates and color suitable for CI (default false)
  -F, --from string   Comma-separated list of location values to match against. For example the partial or full name of a continent, region (e.g eastern europe), country, US state, city or network (default "world").
  -h, --help          help for globalping
  -J, --json          Output results in JSON format (default false)
  -L, --limit int     Limit the number of probes to use (default 1)

Use "globalping [command] --help" for more information about a command.

It seems like the commands are already grouped ? Maybe this change was done recently ?

jimaek commented 1 year ago

Maybe we should also list the --latency parameter globally? And just note that it applies only to specific tests. I want to make sure people are aware that it exists

didil commented 1 year ago

Maybe we should also list the --latency parameter globally? And just note that it applies only to specific tests. I want to make sure people are aware that it exists

ok just did this change