Enum ToolCommand 

pub enum ToolCommand {
    Install {
        package: String,
        php: Option<String>,
        with: Vec<String>,
        force: bool,
    },
    Uninstall {
        package: String,
    },
    Inject {
        package: String,
        with: Vec<String>,
    },
    Uninject {
        package: String,
        with: Vec<String>,
    },
    List,
    Dir {
        package: Option<String>,
    },
    Run(ToolRunArgs),
    Bgx(BgxArgs),
    Upgrade {
        package: Option<String>,
        all: bool,
        reinstall: bool,
    },
}

Variants

Install

Install a tool. Pass <vendor>/<name> optionally followed by @<constraint> (e.g. phpstan/phpstan@^1.10).

Fields

package: String

Composer package identifier, optionally with @<constraint>.

php: Option<String>

Pin the tool to a specific PHP. Accepts a version (8.3, 8.3.12) or a constraint (~8.3, >=8.2,<8.4). When the requested PHP isn’t installed, bougie installs it automatically. Defaults to the highest installed NTS PHP.

with: Vec<String>

Additional Composer package (vendor/name[@<constraint>]) or PHP extension (intl, redis) to install alongside the tool. May be passed multiple times.

force: bool

Overwrite an existing executable at the bin-dir path.

Uninstall

Remove an installed tool by its <vendor>/<name> identifier.

Fields

package: String

Composer package identifier.

Inject

Add an extra composer package or PHP extension to an installed tool. Re-resolves the tool’s lock and updates the vendor tree in place.

Fields

package: String

Composer package identifier of the tool.

with: Vec<String>

Extra to add (vendor/name[@<constraint>] for composer packages, bare name for PHP extensions). Repeatable.

Uninject

Remove an extra previously added via --with / inject.

Fields

package: String

Composer package identifier of the tool.

with: Vec<String>

Extra to remove. Repeatable.

List

List installed tools.

Dir

Print a tool’s install directory, or the tools root if no package is given.

Fields

package: Option<String>

Composer package identifier; omit to print the tools root.

Run(ToolRunArgs)

Run an installed-or-cached tool one-off. Reuses an existing persistent install if (package, constraint, php, with) match exactly; otherwise materialises into the ephemeral cache.

bgx is provided as a convenient alias for bougie tool run; their behavior is identical.

Bgx(BgxArgs)

Upgrade

Re-resolve a tool’s lock and bring its vendor tree up to date. Pass --all to walk every installed tool, or --reinstall to wipe and rebuild from scratch (recovery for broken state).

Fields

package: Option<String>

Composer package identifier. Required unless --all.

all: bool

Upgrade every installed tool.

reinstall: bool

Wipe the tool dir + every entrypoint symlink and reinstall from scratch using the receipt’s pinned (package, constraint, php_version, with, extensions) tuple.

Trait Implementations

impl Debug for ToolCommand

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl FromArgMatches for ToolCommand

fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn from_arg_matches_mut( __clap_arg_matches: &mut ArgMatches, ) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn update_from_arg_matches( &mut self, __clap_arg_matches: &ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

fn update_from_arg_matches_mut<'b>( &mut self, __clap_arg_matches: &mut ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

impl Subcommand for ToolCommand

fn augment_subcommands<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate Self via FromArgMatches::from_arg_matches_mut

fn augment_subcommands_for_update<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate self via FromArgMatches::update_from_arg_matches_mut

fn has_subcommand(__clap_name: &str) -> bool

Test whether Self can parse a specific subcommand