Skip to main content

Install

Requirements​

  • ForgeLoop CLI and generated bots target Node.js 18+ (see the package engines field).
  • Building this documentation site locally uses the website package, which declares Node 20+ for Docusaurus.

Scaffold a new project​

Use your preferred package manager’s “create” flow (all resolve to the same create-forgeloop package):

npm create forgeloop@latest my-bot

You can also run npx create-forgeloop@latest my-bot directly.

Run the project CLI after scaffolding​

Generated projects add create-forgeloop as a dev dependency so forgeloop is available without a global install. From the project root:

npx forgeloop help

Other package managers:

pnpm forgeloop help
yarn forgeloop help

Flags and argv​

ForgeLoop primarily uses long flags (--dir, --yes, …), with a small set of short aliases:

  • -h → --help
  • -V → --version
  • -y → --yes
  • -d <path> → --dir <path>

Other short flags are rejected with an error.

Next: Quickstart — first project, env vars, and dev script.