bpkg-cfg-info(1)

NAME
bpkg-cfg-info - print configuration information

SYNOPSIS

bpkg cfg-info [options]

DESCRIPTION

The cfg-info command prints the current configuration's absolute path, id, type, name, and mode. The mode is only printed if specified. If the --link and/or --backlink options are specified, then this information is also printed for each linked and/or implicitly backlinked configuration, if any. Note that the dangling implicit backlinks are silently skipped, unless --dangling is specified, in which case this information is also printed for them. Note that the information is written to stdout, not stderr.

If the --recursive option is specified together with --link and/or --backlink, then this information is printed for linked and/or implicitly backlinked configuration, recursively.

The output format is regular with each value printed on a separate line and prefixed with the value name. If the --link, --backlink, and/or --dangling options are specified, then information blocks corresponding to linked configurations are separated with blank lines. For example:

path: /path/to/cfg/
uuid: 8d439f03-7342-4502-8b1c-74b173869478
type: target
name: foo
mode: fetch-cache=false
path: /path/to/host-cfg/
uuid: 7ee4dab3-07d9-4163-81c0-3779166a7213
type: host
name: tools
path: /path/to/build2-cfg/
uuid: d453aa2a-92c4-4066-87e4-c8672eed06e1
type: build2
name: modules

CFG-INFO OPTIONS

--link
    Print linked configurations.

--backlink
    Print implicitly backlinked configurations.

--dangling
    Print dangling implicit backlinks.

--recursive
    Print linked configurations recursively.

--directory|-d dir
    Assume configuration is in dir rather than in the current working directory.

COMMON OPTIONS

The common options are summarized below with a more detailed description available in bpkg-common-options(1).

-v  Print essential underlying commands being executed.

-V  Print all underlying commands being executed.

--quiet|-q
    Run quietly, only printing error messages.

--verbose level
    Set the diagnostics verbosity to level between 0 and 6.

--stdout-format format
    Representation format to use for printing to stdout.

--jobs|-j num
    Number of jobs to perform in parallel.

--no-result
    Don't print informational messages about the outcome of performing a command or some of its parts.

--structured-result fmt
    Write the result of performing a command in a structured form.

--progress
    Display progress indicators for long-lasting operations, such as network transfers, building, etc.

--no-progress
    Suppress progress indicators for long-lasting operations, such as network transfers, building, etc.

--diag-color
    Use color in diagnostics.

--no-diag-color
    Don't use color in diagnostics.

--build path
    The build program to be used to build packages.

--build-option opt
    Additional option to be passed to the build program.

--fetch path
    The fetch program to be used to download resources (packages, repository metadata, etc).

--fetch-option opt
    Additional option to be passed to the fetch program.

--fetch-timeout sec
    The fetch and fetch-like (for example, git) program timeout.

--offline
    Do not attempt to download resources (packages, repository metadata, etc), instead taking them from the local fetch cache if available and failing otherwise.

--no-fetch-cache
    Disable local caching of downloaded resources (packages, repository metadata, etc).

--fetch-cache mode
    Comma-separated list of local fetch cache modes.

--fetch-cache-path dir
    The directory of the local fetch cache.

--fetch-cache-session id
    The local fetch cache session.

--sqlite-synchronous mode
    Filesystem synchronization mode for the fetch cache and configuration SQLite databases.

--pkg-proxy url
    HTTP proxy server to use when fetching package manifests and archives from remote pkg repositories.

--git path
    The git program to be used to fetch git repositories.

--git-option opt
    Additional common option to be passed to the git program.

--sha256 path
    The sha256 program to be used to calculate SHA256 sums.

--sha256-option opt
    Additional option to be passed to the sha256 program.

--tar path
    The tar program to be used to extract package archives.

--tar-option opt
    Additional option to be passed to the tar program.

--openssl path
    The openssl program to be used for crypto operations.

--openssl-option opt
    Additional option to be passed to the openssl program.

--auth type
    Types of repositories to authenticate.

--trust fingerprint
    Trust repository certificate with a SHA256 fingerprint.

--trust-yes
    Assume the answer to all authentication prompts is yes.

--trust-no
    Assume the answer to all authentication prompts is no.

--git-capabilities up=pc
    Protocol capabilities (pc) for a git repository URL prefix (up).

--pager path
    The pager program to be used to show long text.

--pager-option opt
    Additional option to be passed to the pager program.

--options-file file
    Read additional options from file.

--default-options dir
    The directory to load additional default options files from.

--no-default-options
    Don't load default options files.

--keep-tmp
    Don't remove the bpkg's temporary directory at the end of the command execution and print its path at the verbosity level 2 or higher.

DEFAULT OPTIONS FILES

See bpkg-default-options-files(1) for an overview of the default options files. For the cfg-info command the search start directory is the configuration directory. The following options files are searched for in each directory and, if found, loaded in the order listed:

bpkg.options
bpkg-cfg-info.options

The following cfg-info command options cannot be specified in the default options files:

--directory|-d

BUGS
Send bug reports to the users@build2.org mailing list.

COPYRIGHT
Copyright (c) 2014-2026 the build2 authors. Permission is granted to copy, distribute and/or modify this document under the terms of the MIT License.