Skip to main content

The bud.js CLI

The bud command is your primary means of interfacing with the bud.js framework.

To explore what all is available to you, use bud help. You can also learn about any subcommand using the --help flag.

Extensions may register additional commands which are not reflected here.

$ bud help
━━━ bud - 0.0.0 ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  $ bud <command>

━━━ General commands ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  bud [--notify] [--debug] [--verbose] [--mode #0] [--filter #0]
    Run `bud --help` for usage information

  bud doctor [--notify] [--debug] [--verbose] [--mode #0] [--filter #0]
    Check project for common errors

  bud repl [--notify] [--debug] [--verbose] [--mode #0] [--filter #0] [--color,-c] [--indent,-i #0] [--depth,-d #0]
    Use bud in a repl

  bud view [--notify] [--debug] [--verbose] [--mode #0] [--filter #0] [--color,-c] [--indent,-i] [subject]
    Explore bud object

━━━ build ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  bud build [--notify] [--debug] [--verbose] [--mode #0] [--filter #0] [--cache] [--clean] [--devtool #0] [--editor] [--esm] [--flush,--force] [--hash] [--html] [--immutable] [--discover,--discovery] [--manifest] [--minimize] [--input,-i,--@src,--src #0] [--output,-o,--@dist,--dist #0] [--publicPath #0] [--runtime] [--splitChunks,--vendor] [--storage #0] [--ci] [--use #0]
    Compile source assets

  bud build development [--notify] [--debug] [--verbose] [--mode #0] [--filter #0] [--cache] [--clean] [--devtool #0] [--editor] [--esm] [--flush,--force] [--hash] [--html] [--immutable] [--discover,--discovery] [--manifest] [--minimize] [--input,-i,--@src,--src #0] [--output,-o,--@dist,--dist #0] [--publicPath #0] [--runtime] [--splitChunks,--vendor] [--storage #0] [--ci] [--use #0] [--hot] [--port #0] [--proxy #0] [--reload] [--overlay] [--indicator] [--browser]
    Compiles source assets in `development` mode.

  bud build production [--notify] [--debug] [--verbose] [--mode #0] [--filter #0] [--cache] [--clean] [--devtool #0] [--editor] [--esm] [--flush,--force] [--hash] [--html] [--immutable] [--discover,--discovery] [--manifest] [--minimize] [--input,-i,--@src,--src #0] [--output,-o,--@dist,--dist #0] [--publicPath #0] [--runtime] [--splitChunks,--vendor] [--storage #0] [--ci] [--use #0]
    Compiles source assets in `production` mode.

━━━ tasks ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  bud clean [--notify] [--debug] [--verbose] [--mode #0] [--filter #0] [@storage,storage] [@dist,dist,output] [@cache,cache]
    Clean project artifacts and caches

  bud upgrade [--notify] [--debug] [--verbose] [--mode #0] [--filter #0] [--registry #0] [version]
    Set bud.js version

━━━ tools ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  bud webpack [--notify] [--debug] [--verbose] [--mode #0] [--filter #0] ...
    Webpack CLI passthrough

You can also print more details about any of these commands by calling them with 
the `-h,--help` flag right after the command name.

TypeScript binary​

When using a configuring authored in TypeScript, you will need to either:

  • use the ts-bud command in place of bud
  • use ts-node to execute the bud CLI bin

Bun binary​

If you use the bun runtime you can execute bud with it and have it used in place of node globally by using the bund command