Installation

Installation of BeDoc is straightforward and can be done via npm or yarn. BeDoc requires Node.js v24 or later (engines.node is >=24).

Installation

BeDoc may be run as a standalone tool or as part of a project.

Standalone

Installing BeDoc globally enables you to run it from the command line as well as use it in your projects.

NPM

npm i -g @gesslar/bedoc

Yarn

yarn global add @gesslar/bedoc

Project

If you prefer to keep BeDoc local to your project, you can install it as a development dependency.

NPM

npm i -D @gesslar/bedoc

Yarn

yarn add --dev @gesslar/bedoc

No install (npx)

You don’t have to install BeDoc at all. npx will fetch and run it on demand — handy for one-off runs, trying it out, or CI steps where you’d rather not add a dependency.

# Run the latest published version directly
npx @gesslar/bedoc --version

# Generate docs in a single shot
npx @gesslar/bedoc -l lpc -f markdown -i "src/**/*.c" -o docs

Tip

If BeDoc is already a dependency of your project, plain npx bedoc will use the locally installed copy instead of downloading it.

Verifying Your Installation

After installation, you can confirm that BeDoc is available by running:

Global Install

bedoc --version

Local Install

npx bedoc --version

To see available options, run:

Global Install

bedoc --help

Local Install

npx bedoc --help

Next Steps

After installation, you can start generating documentation with BeDoc. Check out the Configuration Guide to learn how to configure the tool via CLI options, environment variables, JSON files, and more, as well as how to incorporate BeDoc into your project workflow.