Command Line Usage
The Bridgetown gem makes the
bridgetown executable available to you in your terminal. In a site project, a binstub is provided in the
bin folder so you can execute
bin/bridgetown and ensure you’re using the correct version of Bridgetown as specified in your
You can use this command in a number of ways:
bridgetown new PATH- Creates a new Bridgetown site at the specified path with a default configuration and typical site folder structure. Use the
-aoption to apply an automation to the new site.
bridgetown start- Boots the Rack-based server (using Puma)—and in development, load build processes in the background along with Browsersync.
bridgetown deploy- Ensures that all frontend assets get built alongside the published Bridgetown output. This is the command you’ll want to use for (Jamstack deployments).
bridgetown b- Performs a single build of your site to the
outputfolder (by default). Add the
-wflag to also regenerate the site whenever a source file changes.
bridgetown c- Opens up an IRB console and lets you inspect your site configuration and content “under the hood” using Bridgetown’s native Ruby API.
bridgetown plugins [list|cd]- Display information about installed plugins or allow you to copy content out of gem-based plugins into your site folders.
bridgetown apply- Run an automation script for your existing site.
bridgetown configure CONFIGURATION- Run a bundled configuration for your existing site. Invoke without arguments to see all available configurations.
bridgetown help- Shows help, optionally for a given subcommand, e.g.
bridgetown help build.
bridgetown doctor- Outputs any deprecation or configuration issues.
bridgetown clean- Removes all generated files: destination folder, metadata file, and Bridgetown caches.
bridgetown webpack ACTION- Allows you to perform actions such as
updateon your project’s Webpack configuration. Invoke without arguments to see all available actions.
To change Bridgetown’s default build behavior have a look through the configuration options.
For deployment, if you need to add an extra step to copy
output to a web server or run some script post-build, putting that in the
deploy task in your
Rakefile is a good way to go.
Alos take a look at the
scripts configuration in
package.json which provides integration points with the Webpack frontend bundler.