Note

This documentation is for the new OMERO 5.3 version. See the latest OMERO 5.2.x version or the previous versions page to find documentation for the OMERO version you are using if you have not upgraded yet.

Installation

Note

The end of Windows support for OMERO.server means that the CLI is currently unsupported on this platform too. However, we intend to make OMERO.python installable via pip for future releases which would restore Windows support for the CLI.

Check you have Python installed by typing:

$ python --version
Python 2.7.9

Additionally, Ice must be installed on your machine:

$ python -c "import Ice"

Check the server requirements for the minimum and maximum supported versions.

The CLI is currently bundled:

• with the OMERO.server including all functionalities of the CLI
• with the OMERO.python including all functionalities of the CLI except for the import functionality

Download the version corresponding to your system from the OMERO downloads page.

Note

The CLI is bundled with the OMERO.server but that does not imply you must use that directory as a server. You can download the server zip to a number of machines and use the CLI commands from each machine to access an existing OMERO instance.

Once the correct bundle is downloaded, the Python libraries of the CLI are located under the lib/python directory and the executable is under the bin directory. To start the CLI in shell mode:

$ bin/omero
OMERO Python Shell. Version 5.3.2-ice35
Type "help" for more information, "quit" or Ctrl-D to exit
omero>