Official command-line client for RIPE Atlas
Clone or download
Jterbeest Merge pull request #203 from kramse/friendly-403
Trying to make the initial experience better, if 403 errors
Latest commit c815fe5 Aug 22, 2018

README.rst

RIPE Atlas Tools (Magellan)

Documentation Status Build Status PYPI Version Python Versions Python Implementations Python Format Requirements Status

The official command-line client for RIPE Atlas.

Full Documentation

Everything is up on ReadTheDocs

How Does it Work?

Presently, the setup is pretty crude. You can create a ping or traceroute measurement with limited options from the command line:

$ ripe-atlas measure ping --target example.com
$ ripe-atlas measure ping --packets 7 --size 42 --target example.com
$ ripe-atlas measure traceroute --target example.com
$ ripe-atlas measure traceroute --packets 2 --target example.com
$ ripe-atlas measure dns --query-argument example.com
$ ripe-atlas measure dns --use-probe-resolver --query-type AAAA --query-argument example.com

This will create a one-off measurement and then wait for the results to roll in, formatting them as they do.

You can also use it to connect to a stream of formatted data. This command will start streaming out all of the results from one of our oldest measurements:

$ ripe-atlas stream 1001

Or you can generate a simple report:

$ ripe-atlas report 1001

Configuration is done by way of a config file, and modifying it can be done from the command line:

$ ripe-atlas configure --set authorisation.create=MY_API_KEY

Can I Contribute?

Absolutely. Please read our guide on how to contribute.

Colophon

This project was code-named by means of a poll. In order to conform to the RIPE Atlas theme, it had to be named for an explorer, and so the winning suggestion was for Magellan, "in memory of those times when RTT was ~3 years".