Skip to main content

Migration Guide to @aquaringlab/aidk

Due to the renaming and transfer of the package from @caeruxlab/aidk to @aquaringlab/aidk (and the registry migration from GitLab to GitHub Packages), all current users must follow the migration steps below to continue using and updating the AIDK CLI tool.

Migration Steps​

Step 1: Uninstall the Old Package @caeruxlab/aidk​

Run the following command to uninstall the old globally installed version:

npm uninstall -g @caeruxlab/aidk

If you previously used npm link for local development, unlink it:

npm unlink -g @caeruxlab/aidk

Step 2: Generate a New GitHub Personal Access Token (PAT)​

Since @aquaringlab/aidk is published as a private package on GitHub Packages, you need a Personal Access Token with package-reading permission:

  1. Go to github.com/settings/tokens → Generate new token (Classic).
  2. Give it a descriptive name (e.g., AIDK-Read-Token).
  3. Select the read:packages scope.
  4. Click Generate token and copy the generated token.

Step 3: Update Global .npmrc​

Open your global npm configuration file (~/.npmrc) and:

  1. Remove the old GitLab configurations (if present): 
    # Remove these lines (if present)
    @caeruxlab:registry=https://git.caerux.com/api/v4/...
    //git.caerux.com/api/v4/...:_authToken=...
  2. Add the new GitHub Packages configuration, replacing YOUR_GITHUB_PAT with the token generated in Step 2: 
    @aquaringlab:registry=https://npm.pkg.github.com
    //npm.pkg.github.com/:_authToken=YOUR_GITHUB_PAT

Step 4: Install the New @aquaringlab/aidk Package​

Once the .npmrc file is saved, run the following command to install the latest version of the AIDK CLI globally:

npm install -g @aquaringlab/aidk

Step 5: Verify & Use​

Confirm that the installation was successful by running:

aidk --version

From now on, all your projects will use the CLI tool managed via GitHub Packages under the @aquaringlab scope.