.TH DUB-DESCRIBE 1 "2024-07-07" "The D Language Foundation" "The D Language Foundation"
.SH NAME
dub-describe \- Prints a JSON description of the project and its dependencies
.SH SYNOPSIS
\fBdub describe \fR[<\fIpackage\fR>[@<\fIversion-spec\fR>]] \fIOPTIONS\&.\&.\&.\fR
.SH DESCRIPTION
Prints a JSON build description for the root package an all of their dependencies in a format similar to a JSON package description file. This is useful mostly for IDEs.



All usual options that are also used for build/run/generate apply.



When --data=VALUE is supplied, specific build settings for a project will be printed instead (by default, formatted for the current compiler).



The --data=VALUE option can be specified multiple times to retrieve several pieces of information at once. A comma-separated list is also acceptable (ex: --data=dflags,libs). The data will be output in the same order requested on the command line.



The accepted values for --data=VALUE are:



main-source-file, dflags, lflags, libs, linker-files, source-files, versions, debug-versions, import-paths, string-import-paths, import-files, options



The following are also accepted by --data if --data-list is used:



target-type, target-path, target-name, working-directory, copy-files, string-import-files, pre-generate-commands, post-generate-commands, pre-build-commands, post-build-commands, pre-run-commands, post-run-commands, requirements
.SH OPTIONS
.PP
\fB\-b\fR, \fB\-\-build\fR=\fIVALUE\fR
.RS 4
Specifies the type of build to perform. Note that setting the DFLAGS environment variable will override the build type with custom flags.
Possible names:
  debug, plain, release, release-debug, release-nobounds, unittest, profile, profile-gc, docs, ddox, cov, cov-ctfe, unittest-cov, unittest-cov-ctfe, syntax and custom types
.RE
.PP
\fB\-c\fR, \fB\-\-config\fR=\fIVALUE\fR
.RS 4
Builds the specified configuration. Configurations can be defined in dub.json
.RE
.PP
\fB\-\-override\-config\fR=\fIVALUE\fR
.RS 4
Uses the specified configuration for a certain dependency. Can be specified multiple times.
Format: --override-config=<dependency>/<config>
.RE
.PP
\fB\-\-compiler\fR=\fIVALUE\fR
.RS 4
Specifies the compiler binary to use (can be a path).
Arbitrary pre- and suffixes to the identifiers below are recognized (e.g. ldc2 or dmd-2.063) and matched to the proper compiler type:
  dmd, gdc, ldc, gdmd, ldmd
.RE
.PP
\fB\-a\fR, \fB\-\-arch\fR=\fIVALUE\fR
.RS 4
Force a different architecture (e.g. x86 or x86_64)
.RE
.PP
\fB\-d\fR, \fB\-\-debug\fR=\fIVALUE\fR
.RS 4
Define the specified `debug` version identifier when building - can be used multiple times
.RE
.PP
\fB\-\-d\-version\fR=\fIVALUE\fR
.RS 4
Define the specified `version` identifier when building - can be used multiple times.
Use sparingly, with great power comes great responsibility! For commonly used or combined versions and versions that dependees should be able to use, create configurations in your package.
.RE
.PP
\fB\-\-nodeps\fR
.RS 4
Do not resolve missing dependencies before building
.RE
.PP
\fB\-\-build\-mode\fR=\fIVALUE\fR
.RS 4
Specifies the way the compiler and linker are invoked. Valid values:
  separate (default), allAtOnce, singleFile
.RE
.PP
\fB\-\-single\fR
.RS 4
Treats the package name as a filename. The file must contain a package recipe comment.
.RE
.PP
\fB\-\-force\-remove\fR
.RS 4
Deprecated option that does nothing.
.RE
.PP
\fB\-\-filter\-versions\fR
.RS 4
[Experimental] Filter version identifiers and debug version identifiers to improve build cache efficiency.
.RE
.PP
\fB\-\-import\-paths\fR
.RS 4
Shortcut for --data=import-paths --data-list
.RE
.PP
\fB\-\-string\-import\-paths\fR
.RS 4
Shortcut for --data=string-import-paths --data-list
.RE
.PP
\fB\-\-data\fR=\fIVALUE\fR
.RS 4
Just list the values of a particular build setting, either for this package alone or recursively including all dependencies. Accepts a comma-separated list. See above for more details and accepted possibilities for VALUE.
.RE
.PP
\fB\-\-data\-list\fR
.RS 4
Output --data information in list format (line-by-line), instead of formatting for a compiler command line.
.RE
.PP
\fB\-\-data\-0\fR
.RS 4
Output --data information using null-delimiters, rather than spaces or newlines. Result is usable with, ex., xargs -0.
.RE
.SS COMMON OPTIONS
See \fBdub\fR(1)
.SH EXIT STATUS
.TP
.BR 0
DUB succeeded
.TP
.BR 1
usage errors, unknown command line flags
.TP
.BR 2
package not found, package failed to load, miscellaneous error
.SH FILES
\fIdub\&.sdl\fR, \fIdub\&.json\fR
.SH AUTHOR
Copyright (c) 1999-2024 by The D Language Foundation
.SH ONLINE DOCUMENTATION
.URhttp://code.dlang.org/docs/commandline
http://code.dlang.org/docs/commandline
.UE
.SH SEE ALSO
\fBdub\fR(1), \fBdub-generate\fR(1)