Skip to main content

Installation

Getting started with NodeArch is simple. With just a few steps, you’ll have everything you need to build structured, scalable, and maintainable Node.js applications.

Prerequisites​

Before installing NodeArch, make sure you have the following tools installed:

  • Node.js >= 20.x
  • npm or yarn
  • A basic understanding of TypeScript is recommended

To check your versions:

node -v
npm -v

Installing the CLI​

NodeArch provides a powerful CLI that helps you create, build, and run applications.

Install it globally via npm:

npm install -g @nodearch/cli

Once installed, you can confirm it’s working with:

nodearch -h

This will display all available commands and options.

Quick Check​

To ensure the CLI is correctly installed, try running:

nodearch -v

You should see the currently installed version of the CLI.

✅ That’s it — you’re ready to build with NodeArch!