Skip to content

Installation

These docs describe avenx-core@1.0.0-rc.1.

Before installing the Avenx CLI, ensure your environment meets the following requirements:

  • Node.js: Version 18.0.0 or later is strictly required.
  • Compatibility Check: Upon startup, the CLI automatically verifies your Node.js engine version. Running the CLI on unsupported, older environments will cause the application to terminate immediately with an exit code 1.

To begin using Avenx-JS, make sure you have Node.js v18 or later installed on your machine. The CLI refuses to run on anything older.

Install the Avenx package globally or locally in your project:

Terminal window
npm install avenx-core@rc

The rc tag selects the documented version; latest points to the older 0.4.3.

Or run it directly using npx to initialize a new project structure:

Terminal window
npx --package avenx-core@rc avenx init
Dependency Requirement Purpose
Node.js v18.0.0+ Running CLI commands and local dev server
NPM / Yarn v7.0.0+ Installing dependency packages
Modern Browser ES6 Proxy support Required for the reactive runtime engine