Dev Guide

If you want to contribute or test locally you can follow these steps.

Setup

1. Install dependencies for all packages:

   npm install

2. Build all packages (SDK, Portal, and CLI):

   npm run build

Making Changes to the CLI

When you make changes to the CLI source code (packages/cli/src/), you need to rebuild:

1. Build the CLI (compiles TypeScript to JavaScript):

   npm run build:cli

Testing Your Changes

After building and packing, test your changes in a local mod project:

1. Navigate to your test project (e.g., MyMod/ or any mod folder):

   cd MyMod

2. Install the locally built CLI:

   npm install ../packages/cli

3. Test the CLI commands:

   npm run build
   npm run dev

4. Fixing linting issues:

   npm run lint:fix    # Auto-fix issues

Running Tests

Run the test suite to ensure everything works:

npm test