Builder CLI

When working on a Bingo template repository, it can be useful to quickly preview file changes locally. Bingo provides a bingo CLI that directly runs a template.

For example, running a ./template.js file:

npm

npx bingo ./template.js

pnpm

pnpx bingo ./template.js

yarn

yarn dlx bingo ./template.js

npx bingo ./template.js

┌  ✨ bingo@0.5.0 ✨
│
│  Learn more on: https://create.bingo/build
│
│  Running with mode --setup for a new repository using:
│    ./template.js

The path passed to bingo must resolve to a file that export defaults a Bingo template. See:

• Concepts > Templates: for more information on what templates are
• APIs > createTemplate: for documentation on how to create a template

Common Flags

bingo supports all the flags under CLI > Common Flags.

For example, running a local ./template.js file with a custom --directory:

npm

npx bingo ./template.js --directory my-fancy-project

pnpm

pnpx bingo ./template.js --directory my-fancy-project

yarn

yarn dlx bingo ./template.js --directory my-fancy-project

Template Flags

bingo additionally supports any CLI flags added in by the template.

For example, if a template defines a title option, --title will be type string:

npm

npx bingo ./template.js --title 'My New App'

pnpm

pnpx bingo ./template.js --title 'My New App'

yarn

yarn dlx bingo ./template.js --title 'My New App'

Any required options that are not provided will be prompted for interactively.

Tip

See the documentation for your specific template for additional flags.