1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
|
.. _debusine-cli:
====================
The debusine command
====================
The ``debusine`` command is a command line interface to the Debusine API.
It is provided by the ``debusine-client`` package and contains many
sub-commands.
The configuration file is documented in :ref:`debusine-cli-config`.
Output of the ``debusine`` command
----------------------------------
If the ``debusine`` command succeeds, it prints relevant information to the
standard output in YAML format.
If an error occurs, the error messages will be printed to the standard error.
Return values
-------------
Return values of the ``debusine`` command:
=============== ==================================================================================
Return value Meaning
=============== ==================================================================================
0 Success
1 Error: unhandled exception. Please report the error
2 Error: wrong arguments and options
3 Error: any other type of error such as connection to the server is not possible,
invalid configuration file, etc.
=============== ==================================================================================
Sub-commands
------------
``debusine`` provides sub-commands to manipulate
:ref:`explanation-work-requests`, :ref:`explanation-workflows`,
:ref:`explanation-artifacts`, etc., described in ``--help``:
.. code-block:: console
$ debusine --help
usage: debusine [-h] [--server SERVER] [--config-file CONFIG_FILE] [-s] [-d]
{list-work-requests,show-work-request,create-work-request,manage-work-request,create-workflow-template,[...]}
...
Interacts with a Debusine server.
positional arguments:
{list-work-requests,show-work-request,create-work-request,manage-work-request,create-workflow-template,[...]}
Sub command
list-work-requests List all work requests
show-work-request Print the status of a work request
create-work-request
Create a work request and schedule the execution. Work request is read from stdin in YAML format
manage-work-request
Manage a work request
create-workflow-template
Create a workflow template
[...]
If you have multiple servers configured, then you may need to select which
one to use. You can do this using ``--server FQDN/SCOPE`` (for example,
``--server debusine.debian.net/debian``), or using ``--server NAME`` (where
the available names are shown by ``debusine setup``).
For convenience in scripts, you can use the ``DEBUSINE_SERVER_NAME``
environment variable instead of specifying ``--server``. When both are used,
``--server`` has priority.
Each sub-command is self-documented, use ``debusine sub-command
--help``:
.. code-block:: console
$ debusine create-workflow --help
usage: debusine create-workflow [-h] [--workspace WORKSPACE] [--data DATA] template_name
positional arguments:
[...]
|
