blob: 1162e6c445ab71d62ed4c57f584afcc113b40315 (
plain)
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
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
|
.. _commands:
Commands
========
This page contains documentation for each BuildStream command,
along with their possible options and arguments. Each command can be
invoked on the command line, where, in most cases, this will be from the
project's main directory.
Top-level commands
------------------
.. The bst options e.g. bst --version, or bst --verbose etc.
.. _invoking_bst:
.. click:: buildstream._frontend:cli
:prog: bst
.. Further description of the command goes here
----
.. _invoking_artifact:
.. click:: buildstream._frontend.cli:artifact
:prog: bst artifact
----
.. the `bst init` command
.. _invoking_init:
.. click:: buildstream._frontend.cli:init
:prog: bst init
----
.. the `bst build` command
.. _invoking_build:
.. click:: buildstream._frontend.cli:build
:prog: bst build
----
.. _invoking_show:
.. click:: buildstream._frontend.cli:show
:prog: bst show
----
.. _invoking_shell:
.. click:: buildstream._frontend.cli:shell
:prog: bst shell
----
.. _invoking_source:
.. click:: buildstream._frontend.cli:source
:prog: bst source
----
.. _invoking_workspace:
.. click:: buildstream._frontend.cli:workspace
:prog: bst workspace
.. _artifact_subcommands:
Artifact subcommands
--------------------
.. _artifact_names:
Artifact names
~~~~~~~~~~~~~~
Various artifact subcommands accept either :ref:`element names <format_element_names>`,
which will operate on artifacts by deriving the artifact from local project state,
or :term:`artifact names <Artifact name>` interchangeably as targets. Artifact names allow
the user to operate directly on cached artifacts, without requiring local project data.
An artifact name is composed of the following identifiers:
* The :ref:`project name <project_format_name>`
* The :ref:`element name <format_element_names>`, without any trailing ``.bst`` extension
* The cache key of the element at the time it was built.
To compose an artifact name, simply join these using a forward slash (``/``) character, like so: ``<project-name>/<element-name>/<cache-key>``.
An artifact name might look like: ``project/target/788da21e7c1b5818b7e7b60f7eb75841057ff7e45d362cc223336c606fe47f27``
.. _invoking_artifact_checkout:
.. click:: buildstream._frontend.cli:artifact_checkout
:prog: bst artifact checkout
----
.. _invoking_artifact_log:
.. click:: buildstream._frontend.cli:artifact_log
:prog: bst artifact log
----
.. _invoking_artifact_pull:
.. click:: buildstream._frontend.cli:artifact_pull
:prog: bst artifact pull
----
.. _invoking_artifact_push:
.. click:: buildstream._frontend.cli:artifact_push
:prog: bst artifact push
----
.. _invoking_artifact_delete:
.. click:: buildstream._frontend.cli:artifact_delete
:prog: bst artifact delete
----
.. _invoking_artifact_show:
.. click:: buildstream._frontend.cli:artifact_show
:prog: bst artifact show
----
.. _invoking_artifact_list_contents:
.. click:: buildstream._frontend.cli:artifact_list_contents
:prog: bst artifact list-contents
.. _source_subcommands:
Source subcommands
------------------
.. _invoking_source_fetch:
.. click:: buildstream._frontend.cli:source_fetch
:prog: bst source fetch
----
.. _invoking_source_track:
.. click:: buildstream._frontend.cli:source_track
:prog: bst source track
----
.. _invoking_source_push:
.. click:: buildstream._frontend.cli:source_push
:prog: bst source push
----
.. _invoking_source_checkout:
.. click:: buildstream._frontend.cli:source_checkout
:prog: bst source checkout
.. _workspace_subcommands:
Workspace subcommands
---------------------
.. _invoking_workspace_open:
.. click:: buildstream._frontend.cli:workspace_open
:prog: bst workspace open
----
.. _invoking_workspace_close:
.. click:: buildstream._frontend.cli:workspace_close
:prog: bst workspace close
----
.. _invoking_workspace_reset:
.. click:: buildstream._frontend.cli:workspace_reset
:prog: bst workspace reset
----
.. _invoking_workspace_list:
.. click:: buildstream._frontend.cli:workspace_list
:prog: bst workspace list
|
