Skip to main content

Getting Started

Until there's a proper "Getting started" guide, try getting acquainted with ergogen by following these steps in order:

  1. Read the docs. D'uuh. They're not complete by any measure, but should give you a fairly good idea what you're dealing with here.

  2. Try one of the web-based deployments (official; unofficial but probably better and soon to be official) - no need to download the CLI unless you want to A) preview in-development features, B) use custom modifications, or C) contribute code. Click things, look at outputs; see if things start to make sense.

  3. Search the #ergogen topic on GitHub to look at (and reverse engineer) a variety of real life configs using ergogen. Pop them into the web UI, see what they do, tinker with them; things should start to make more and more sense.

  4. If a question persists after all of the above, feel free to ask it over on Discord and we'll do our best to help you out.

Command line usage#


Requires node v14.4.0+ with npm v6.14.5+ to be installed.

If command line is more your thing, you can install the latest ergogen release by issuing:

npm i -g ergogen

After this, you will be able to use the ergogen command - for example, by specifying an input config and an output folder like so:

ergogen input.yaml -o output_folder

For the full set command line options available, see ergogen --help.

Development usage#

If you want to sneak a peek of the features being developed on the cutting edge, or would like to contribute stuff, you can clone the repo locally by:

git clone ergogennpm install

To use this local copy, you would call node src/cli.js instead of the global ergogen command. So the above example would change to:

node src/cli.js input.yaml -o output_folder