Setup
Installation
Install OpenAudit AI on your system. The npm package is coming soon — until then, set up from source using the local development instructions.
Warning: Package publishing is coming soon. The local development setup is the recommended installation method until the npm release.
Prerequisites
# Node.js 18 or higher required
$node --version
v20.11.0
Install
# Recommended until npm package is published
$git clone https://github.com/NeuroForgeLabs/openaudit-ai.git
$cd openaudit-ai
$npm install
$npm run build
$npm link
System requirements
- Node.js 18.0 or higher
- npm 8.0 or higher
- Git (for local development setup)
- macOS, Linux, or Windows (with Node.js)
Troubleshooting
Permission errors on macOS / Linux
If you get permission errors when running npm install -g, use a Node version manager like nvm or fnm to avoid needing sudo.
# Install nvm to manage Node versions
$curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.0/install.sh | bash
$nvm install 18 && nvm use 18
Build errors in local dev
If the build fails, ensure your Node version is 18 or higher and run npm install again to restore any missing modules.