1bdep-status(1) General Commands Manual bdep-status(1)
2
6 bdep-status - print status of project and/or its dependencies
7
9 bdep status [options] [pkg-spec] [cfg-spec] [dep-spec...]
10 dep-spec = pkg[/ver]
12 cfg-spec = (@cfg-name | --config|-c cfg-dir)... | --all|-a
13 pkg-spec = (--directory|-d pkg-dir)... | prj-spec
14 prj-spec = --directory|-d prj-dir
15
17 The status command prints the status of project packages and/or their
18 dependencies in one or more build configurations.
19 If no project or package directory is specified, then the current work‐
21 ing directory is assumed. If no configuration is specified, then the
22 default configurations are assumed. See bdep-projects-configs(1) for
23 details on specifying projects and configurations.
24 If no dep-spec arguments are specified, then status prints the status
26 of the project's packages. Otherwise, the status of the specified de‐
27 pendency packages is printed. Additionally, the status of immediate or
28 all dependencies of the above packages can be printed by specifying the
29 --immediate|-i or --recursive|-r options, respectively.
30 In the default output format (see the --stdout-format common option),
32 the status of each package is printed on a separate line. Note that the
33 status is written to stdout, not stderr. The semantics of dep-spec and
34 the format of the status line are described in bpkg-pkg-status(1).
35 If the output format is json, then the output is a JSON array of ob‐
37 jects which are the serialized representation of the following C++
38 struct configuration_package_status:
39 struct configuration
41 {
42 uint64_t id;
43 string path;
44 optional<string> name;
45 };
46 struct configuration_package_status
48 {
49 configuration configuration;
50 vector<package_status> packages;
51 };
52 For example:
54 [
56 {
57 "configuration": {
58 "id": 1,
59 "path": "/tmp/hello-gcc",
60 "name": "gcc"
61 },
62 "packages": [
63 {
64 "name": "hello",
65 "status": "configured",
66 "version": "1.0.0",
67 "hold_package": true,
68 "available_versions": [
69 {
70 "version": "1.0.1"
71 },
72 {
73 "version": "2.0.0"
74 }
75 ],
76 "dependencies": [
77 {
78 "name": "libhello",
79 "status": "configured",
80 "version": "1.0.2"
81 }
82 ]
83 }
84 ]
85 }
86 ]
87 See the JSON OUTPUT section in bdep-common-options(1) for details on
89 the overall properties of this format and the semantics of the struct
90 serialization.
91 Refer to the list subcommand of bdep-config(1) for details on the
93 struct configuration members. Refer to bpkg-pkg-status(1) for the defi‐
94 nition of struct package_status. Note also that in the json output for‐
95 mat certain conditions (no associated configurations, no initialized
96 packages, etc) are not treated as errors but instead result in valid
97 output. The uninitialized packages have the special uninitialized sta‐
98 tus value.
99
101 --immediate|-i
102 Also print the status of immediate dependencies.
103 --recursive|-r
105 Also print the status of all dependencies, recursively.
106 --old-available|-o
108 Print old available versions.
109 --fetch|-f
111 Perform the fetch command prior to printing the status.
112 --fetch-full|-F
114 Perform the fetch --full command prior to printing the status.
115 --all|-a
117 Use all build configurations.
118 --config|-c dir
120 Specify the build configuration as a directory.
121 --directory|-d dir
123 Assume project/package is in the specified directory rather than
124 in the current working directory.
125 --config-name|-n name
127 Specify the build configuration as a name.
128 --config-id num
130 Specify the build configuration as an id.
131
133 The common options are summarized below with a more detailed descrip‐
134 tion available in bdep-common-options(1).
135 -v Print essential underlying commands being executed.
137 -V Print all underlying commands being executed.
139 --quiet|-q
141 Run quietly, only printing error messages.
142 --verbose level
144 Set the diagnostics verbosity to level between 0 and 6.
145 --stdout-format format
147 Representation format to use for printing to stdout.
148 --jobs|-j num
150 Number of jobs to perform in parallel.
151 --progress
153 Display progress indicators for long-lasting operations, such as
154 network transfers, building, etc.
155 --no-progress
157 Suppress progress indicators for long-lasting operations, such
158 as network transfers, building, etc.
159 --diag-color
161 Use color in diagnostics.
162 --no-diag-color
164 Don't use color in diagnostics.
165 --bpkg path
167 The package manager program to be used for build configuration
168 management.
169 --bpkg-option opt
171 Additional option to be passed to the package manager program.
172 --build path
174 The build program to be used to build packages.
175 --build-option opt
177 Additional option to be passed to the build program.
178 --curl path
180 The curl program to be used for network operations.
181 --curl-option opt
183 Additional option to be passed to the curl program.
184 --pager path
186 The pager program to be used to show long text.
187 --pager-option opt
189 Additional option to be passed to the pager program.
190 --options-file file
192 Read additional options from file.
193 --default-options dir
195 The directory to load additional default options files from.
196 --no-default-options
198 Don't load default options files.
199
201 See bdep-default-options-files(1) for an overview of the default op‐
202 tions files. For the status command the search start directory is the
203 project directory. The following options files are searched for in each
204 directory and, if found, loaded in the order listed:
205 bdep.options
207 bdep-status.options
208 The following status command options cannot be specified in the default
210 options files:
211 --directory|-d
213
215 Send bug reports to the users@build2.org mailing list.
216
218 Copyright (c) 2014-2023 the build2 authors.
219 Permission is granted to copy, distribute and/or modify this document
221 under the terms of the MIT License.
222bdep 0.16.0 June 2023 bdep-status(1)