@bimsystems/core

Core CLI & utilities for BIMSystems

This package provides the foundational CLI and utilities for initializing and configuring BIMSystems modules (e.g., inventory, ERP, etc.).

Features

• Interactive CLI (bim) to bootstrap your inventory project
• Database selection prompt (BimDB, SQLite)
• Generates .env.local entries and bimsystems.config.json

Installation

# Install locally as dev dependency
npm install --save-dev @bimsystems/core

# Or install globally for system-wide CLI
npm install -g @bimsystems/core

Usage

via npx (local install)

npx bim

via global install or npm script

# if installed globally:
bim

# or add to package.json:
# "scripts": { "bims": "bim" }
npm run bims

CLI Walkthrough

1. Select database

   • BIM Database: our hosted Supabase instance
   • SQLite (local file): zero-configuration local file (default)

2. Fill in credentials (if needed)

   • Prompts will collect URL, keys, or connection string

3. Configuration files

   • Appends env variables to .env.local
   • Writes a bimsystems.config.json with your selection

4. Apply migrations

   • Run your migration command (e.g., npm run bim:migrate or supabase db push)

Example

# initialize config
npx bimsystems

# sample output:
# ? Which database? (Use arrow keys)
#     BIM Database
#   › SQLite (local file)
# ✔ Will use SQLite at ./bim.db
# 🎉 Configuration saved to bimsystems.config.json

# now run migrations
npm run bim:migrate

Contributing

BIMSystems is open source! Feel free to file issues or submit PRs to improve the CLI or add new modules.

License

MIT © BIMSystems