home | help 
bdep-clean(1)		     General Commands Manual		   bdep-clean(1)

NAME
     bdep-clean - clean project in build configurations

SYNOPSIS
     bdep clean [options] [pkg-spec] [cfg-spec] [cfg-var...]

     cfg-spec = (@cfg-name | --config|-c cfg-dir)... | --all|-a
     pkg-spec = (pkg | (--directory|-d pkg-dir))... | prj-spec
     prj-spec = --directory|-d prj-dir

DESCRIPTION
     The clean command cleans the project packages in one or more build configu-
     rations.  Additionally,  immediate or all dependencies of the project pack-
     ages can be cleaned by specifying the --immediate|-i or --recursive|-r  op-
     tions, respectively.

     Underneath clean executes the bpkg-pkg-clean(1) command which itself is not
     much  more than the build system clean operation (see b(1) for details). As
     a result, the main utility of this command is the ability to refer to build
     configurations by names and to project packages implicitly via the  current
     working directory as well as to clean dependencies.

     If  no  project or package directory is specified, then the current working
     directory is assumed. If no configuration is specified,  then  the  default
     configurations  are  assumed.  See  bdep-projects-configs(1) for details on
     specifying projects and configurations. Optional cfg-var... are  the  addi-
     tional configuration variables to pass to the build system.

CLEAN OPTIONS
     --immediate|-i
	    Also clean immediate dependencies.

     --recursive|-r
	    Also clean all dependencies, recursively.

     --all|-a
	    Use all build configurations.

     --config|-c dir
	    Specify the build configuration as a directory.

     --directory|-d dir
	    Assume  project/package is in the specified directory rather than in
	    the current working directory.

     --config-name|-n name
	    Specify the build configuration as a name.

     --config-id num
	    Specify the build configuration as an id.

COMMON OPTIONS
     The common options are summarized below with a  more  detailed  description
     available in bdep-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.

     --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.

     --bpkg path
	    The  package manager program to be used for build configuration man-
	    agement.

     --bpkg-option opt
	    Additional option to be passed to the package manager program.

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

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

     --curl path
	    The curl program to be used for network operations.

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

     --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 download resources (packages, repository
	    metadata, etc).

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

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

     --sqlite-synchronous mode
	    Filesystem synchronization mode for the project SQLite database.

     --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.

DEFAULT OPTIONS FILES
     See bdep-default-options-files(1) for an overview of  the	default  options
     files.  For the clean command the search start directory is the project di-
     rectory. The following options files are searched	for  in  each  directory
     and, if found, loaded in the order listed:

     bdep.options
     bdep-clean.options

     The  following clean command options cannot be specified in the default op-
     tions 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.

bdep 0.18.0			   April 2026			   bdep-clean(1)
home | help