UNPKG

bun-types

Version:

Type definitions and documentation for Bun, an incredibly fast JavaScript runtime

164 lines (118 loc) • 4.59 kB
# CLI Usage ```bash bun link <packages> ``` ### Installation Scope <ParamField path="--global" type="boolean"> Install globally. Alias: <code>-g</code> </ParamField> ### Dependency Management <ParamField path="--production" type="boolean"> Don't install devDependencies. Alias: <code>-p</code> </ParamField> <ParamField path="--omit" type="string"> Exclude <code>dev</code>, <code>optional</code>, or <code>peer</code> dependencies from install </ParamField> ### Project Files &amp; Lockfiles <ParamField path="--yarn" type="boolean"> Write a <code>yarn.lock</code> file (yarn v1). Alias: <code>-y</code> </ParamField> <ParamField path="--frozen-lockfile" type="boolean"> Disallow changes to lockfile </ParamField> <ParamField path="--save-text-lockfile" type="boolean"> Save a text-based lockfile </ParamField> <ParamField path="--lockfile-only" type="boolean"> Generate a lockfile without installing dependencies </ParamField> <ParamField path="--no-save" type="boolean"> Don't update <code>package.json</code> or save a lockfile </ParamField> <ParamField path="--save" type="boolean" default="true"> Save to <code>package.json</code> (true by default) </ParamField> <ParamField path="--trust" type="boolean"> Add to <code>trustedDependencies</code> in the project's <code>package.json</code> and install the package(s) </ParamField> ### Installation Control <ParamField path="--force" type="boolean"> Always request the latest versions from the registry &amp; reinstall all dependencies. Alias: <code>-f</code> </ParamField> <ParamField path="--no-verify" type="boolean"> Skip verifying integrity of newly downloaded packages </ParamField> <ParamField path="--backend" type="string" default="clonefile"> Platform-specific optimizations for installing dependencies. Possible values: <code>clonefile</code> (default),{" "} <code>hardlink</code>, <code>symlink</code>, <code>copyfile</code> </ParamField> <ParamField path="--linker" type="string"> Linker strategy (one of <code>isolated</code> or <code>hoisted</code>) </ParamField> <ParamField path="--dry-run" type="boolean"> Don't install anything </ParamField> <ParamField path="--ignore-scripts" type="boolean"> Skip lifecycle scripts in the project's <code>package.json</code> (dependency scripts are never run) </ParamField> ### Network &amp; Registry <ParamField path="--ca" type="string"> Provide a Certificate Authority signing certificate </ParamField> <ParamField path="--cafile" type="string"> Same as <code>--ca</code>, but as a file path to the certificate </ParamField> <ParamField path="--registry" type="string"> Use a specific registry by default, overriding <code>.npmrc</code>, <code>bunfig.toml</code>, and environment variables </ParamField> <ParamField path="--network-concurrency" type="number" default="48"> Maximum number of concurrent network requests (default 48) </ParamField> ### Performance &amp; Resource <ParamField path="--concurrent-scripts" type="number" default="5"> Maximum number of concurrent jobs for lifecycle scripts (default 5) </ParamField> ### Caching <ParamField path="--cache-dir" type="string"> Store &amp; load cached data from a specific directory path </ParamField> <ParamField path="--no-cache" type="boolean"> Ignore manifest cache entirely </ParamField> ### Output &amp; Logging <ParamField path="--silent" type="boolean"> Don't log anything </ParamField> <ParamField path="--quiet" type="boolean"> Only show tarball name when packing </ParamField> <ParamField path="--verbose" type="boolean"> Excessively verbose logging </ParamField> <ParamField path="--no-progress" type="boolean"> Disable the progress bar </ParamField> <ParamField path="--no-summary" type="boolean"> Don't print a summary </ParamField> ### Platform Targeting <ParamField path="--cpu" type="string"> Override CPU architecture for optional dependencies (e.g., <code>x64</code>, <code>arm64</code>, <code>*</code> for all) </ParamField> <ParamField path="--os" type="string"> Override operating system for optional dependencies (e.g., <code>linux</code>, <code>darwin</code>, <code>*</code> for all) </ParamField> ### Global Configuration &amp; Context <ParamField path="--config" type="string"> Specify path to config file (<code>bunfig.toml</code>). Alias: <code>-c</code> </ParamField> <ParamField path="--cwd" type="string"> Set a specific current working directory </ParamField> ### Help <ParamField path="--help" type="boolean"> Print this help menu. Alias: <code>-h</code> </ParamField>