Skip to content

Commit

Permalink
Note the CLI in the README
Browse files Browse the repository at this point in the history
  • Loading branch information
callumforrester committed May 21, 2024
1 parent 99dcff1 commit c99dc77
Showing 1 changed file with 20 additions and 0 deletions.
20 changes: 20 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,26 @@ Documentation https://DiamondLightSource.github.io/dodal
Releases https://github.com/DiamondLightSource/dodal/releases
============== ==============================================================

Testing Connectivity
--------------------

You can test your connection to a beamline if it's PVs are visible to your machine with:

.. code:: shell
# On any workstation:
dodal connect <BEAMLINE>
# On a beamline workstation, this should suffice:
dodal connect ${BEAMLINE}
For more options, including a list of valid beamlines, type

.. code:: shell
dodal connect --help
.. |code_ci| image:: https://github.com/DiamondLightSource/dodal/actions/workflows/code.yml/badge.svg?branch=main
:target: https://github.com/DiamondLightSource/dodal/actions/workflows/code.yml
Expand Down

0 comments on commit c99dc77

Please sign in to comment.