CLI Reference

BitForge is driven entirely by flags. With no action flag, running bitforge inside a workspace loads the project and starts the web server.

bitforge [flags]

Commands

Flag	Argument	Description
`—init`	`[name]`	Bootstrap a workspace in `name` (or the current directory). Clones the base sources and writes the manifest.
`—poky`	`[release]`	Used with `—init`: base the workspace on poky at `release` instead of OpenEmbedded-core.
`—build`	`[target]`	Start a build for `target`, or the `[default]` image when omitted.
`—add-layer`	`<name>`	Scaffold and register a new layer you own under `layers/`.
`—remove-layer`	`<name>`	Remove one of your own layers and de-register it.
`—dependency-add`	`<spec>`	Clone and link upstream layers. See the spec syntax.
`—dependency-remove`	`<name>`	Remove a tracked dependency, its lock entry and its clone.
`—update`	—	Download and install the latest release in place.
`—version`	—	Print the installed BitForge version and exit.

Modifier flags

Flag	Applies to	Description
`—force`	`—init`	Initialize even when the target directory is not empty.
`—beta`	`—update`	Use the latest pre-release instead of the newest stable build.

Argument forms

Flags that take a value accept both an inline and a spaced form, and values may be quoted:

bitforge --init my-distro
bitforge --init=my-distro
bitforge --init "demo poky"
bitforge --poky=scarthgap

Environment variables

Variable	Used by	Description
`BITFORGE_REPO`	`—update`, install script	Override the `owner/name` GitHub repository (default `DraviaVemal/BitForge`).
`BITFORGE_INSTALL_DIR`	install script	Install location (default `~/.local/bin`).

Examples

# Bootstrap a poky workspace and enter it
bitforge --init my-distro --poky scarthgap
cd my-distro

# Add layers and a dependency
bitforge --add-layer sensors
bitforge --dependency-add https://git.openembedded.org/meta-openembedded#meta-oe,meta-python

# Start the server, then build an image
bitforge
bitforge --build core-image-minimal

# Keep the tool current
bitforge --update