Commit 02b4b48d authored by Flavio TARSETTI's avatar Flavio TARSETTI
Browse files

[doc] updated documentation for beat.cmdline

parent 65faeb45
Pipeline #20573 passed with stages
in 43 minutes and 41 seconds
......@@ -28,8 +28,15 @@ The commands available for algorithms are:
.. command-output:: beat algorithms --help
For instance, a list of the algorithms available on the remote platform can
For instance, a list of the algorithms available locally can
be obtained as follows:
.. command-output:: beat algorithms list --remote
.. command-output:: beat algorithms list
For instance, a list of the algorithms available on the remote platform can
be obtained by running the following command:
.. code-block:: sh
$ beat algorithms list --remote
......@@ -27,10 +27,11 @@ Configuration
-------------
The ``beat`` command-line utility can operate independently of any initial
configuration. For example:
configuration. By runnig for example the following command:
.. command-output:: beat df list --remote
:ellipsis: 10
.. code-block:: sh
$ beat df list --remote
By default, the ``beat`` application is pre-configured to access the `main BEAT
......@@ -70,13 +71,40 @@ current working directory as your prefix. You can override this setting using th
...
Note that it is also possible to set a different code editor
.. code-block:: sh
$ ./bin/beat config set editor vim
So we can imagine using the ``edit`` command to edit locally any object.
For example editing an algorithm named ``user/integers_echo/1`` can be done
using the following command:
.. code-block:: sh
$ ./bin/beat algorithm edit user/integers_echo/1
You can also use the ``path`` command on all your objects to identify all
the files and local paths for any given object.
For example we can get the files path associated with the algorithm
named ``user/integers_echo/1`` using the following command:
.. code-block:: sh
$ ./bin/beat algorithm path user/integers_echo/1
Local Overrides
===============
If you use the ``config set`` flag ``--local``, then the configuration values
are not set on the default configuration file (``~/.beatrc``), but instead in
the **current** working directory (``./.beatrc``). Configuration values found
on the local directory take **precedence** over values configured on the global
the local directory take **precedence** over values configured on the global
file. Values from the command-line (such as those passed with ``--prefix`` as
explained above) take precedence over both settings.
......
......@@ -28,10 +28,17 @@ The commands available for databases are:
.. command-output:: beat databases --help
For instance, a list of the databases available on the remote platform can
For instance, a list of the databases available locally can
be obtained as follows:
.. command-output:: beat databases list --remote
.. command-output:: beat databases list
For instance, a list of the databases available on the remote platform can
be obtained by running the following command:
.. code-block:: sh
$ beat databases list --remote
Creating a new database
......
......@@ -29,10 +29,15 @@ The commands available for data formats are:
.. command-output:: beat dataformats --help
:cwd: ..
For instance, a list of the data formats available on the remote platform can
For instance, a list of the data formats available locally can
be obtained as follows:
.. command-output:: beat dataformats list --remote
.. command-output:: beat dataformats list
:cwd: ..
For instance, a list of the data formats available on the remote platform can
be obtained by running the following command:
.. code-block:: sh
$ beat dataformats list --remote
......@@ -40,6 +40,17 @@ The commands available for experiments are:
.. command-output:: beat experiments --help
For instance, a list of the experiments available locally can
be obtained as follows:
.. command-output:: beat experiments list
For instance, a list of the experiments available on the remote platform can
be obtained by running the following command:
.. code-block:: sh
$ beat experiments list --remote
.. _beat-cmdline-experiments-running:
......
......@@ -57,8 +57,7 @@ depending on the object type, a program file containing user routines
programmed in one of the supported languages.
The ``beat`` command-line utility bridges user interaction with a remote BEAT
web platform and locally available objects in a seamless way. The program is
normally available in the Idiap work environment:
web platform and locally available objects in a seamless way:
.. command-output:: beat --help
......
......@@ -28,8 +28,15 @@ The commands available for libraries are:
.. command-output:: beat libraries --help
For instance, a list of the libraries available on the remote platform can
For instance, a list of the libraries available locally can
be obtained as follows:
.. command-output:: beat libraries list --remote
.. command-output:: beat libraries list
For instance, a list of the libraries available on the remote platform can
be obtained by running the following command:
.. code-block:: sh
$ beat libraries list --remote
......@@ -30,9 +30,15 @@ The commands available for plotterparameters are:
.. command-output:: beat plotterparameters --help
For instance, a list of the plotterparameters available on the remote platform can
For instance, a list of the plotterparameters available locally can
be obtained as follows:
.. command-output:: beat plotterparameters list --remote
.. command-output:: beat plotterparameters list
:cwd: ..
For instance, a list of the plotterparameters available on the remote platform can
be obtained by running the following command:
.. code-block:: sh
$ beat plotterparameters list --remote
......@@ -30,12 +30,19 @@ The commands available for plotterparameters are:
.. command-output:: beat plotters --help
For instance, a list of the plotters available on the remote platform can
For instance, a list of the plotters available locally can
be obtained as follows:
.. command-output:: beat plotters list --remote
.. command-output:: beat plotters list
:cwd: ..
For instance, a list of the plotters available on the remote platform can
be obtained by running the following command:
.. code-block:: sh
$ beat plotters list --remote
How to plot a figure?
.........................
......
......@@ -28,6 +28,17 @@ The commands available for toolchains are:
.. command-output:: beat toolchains --help
For instance, a list of the toolchains available locally can
be obtained as follows:
.. command-output:: beat toolchains list
For instance, a list of the toolchains available on the remote platform can
be obtained by running the following command:
.. code-block:: sh
$ beat toolchains list --remote
.. _beat-cmdline-toolchains-checkscript:
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment