CASE CLI

casectl is the operational CLI for the CASE platform.

This repository contains the initial CLI scaffold for CASE.

The goal is to provide a typed operational command-line interface for tasks such as:

• database index management
• migrations
• bootstrap and admin tasks
• environment and connectivity checks

Project structure

src/
  cli.ts
  commands/
    doctor.ts
    db/
      index.ts
      indexes/
        diff.ts
        index.ts
        shared.ts
        ensure.ts
  core/
    config.ts
    not-implemented.ts
  adapters/
    mongodb/
      client.ts
      indexes.ts
test/
  adapters/
    mongodb/
      indexes.test.ts

Commands

Current commands:

casectl --help
casectl help
casectl doctor
casectl doctor --ping --json
casectl db indexes diff --help
casectl db indexes ensure --help

Database configuration

DB commands should target a logical database, not a raw MongoDB database name:

• users
• study
• message
• global

The CLI derives the physical database name from environment variables:

• CASE_DB_NAME_PREFIX
• CASE_DB_INSTANCE_ID for users, study, and message
• CASE_USERS_DB_URI
• CASE_STUDY_DB_URI
• CASE_MESSAGE_DB_URI
• CASE_GLOBAL_DB_URI

Derived names follow this convention:

• users: <prefix><instanceId>_users
• study: <prefix><instanceId>_studyDB
• message: <prefix><instanceId>_messageDB
• global: <prefix>global_infos

For local development, create .env.local from .env.local.example. .env.local is gitignored.

Example:

cp .env.local.example .env.local
pnpm dev doctor
pnpm dev doctor --ping --json
pnpm dev db indexes diff --database study --collection participant_identifiers
pnpm dev db indexes ensure --database study --collection participant_identifiers --dry-run
pnpm dev db indexes ensure --database study --collection participant_identifiers

Development

Requirements:

• Node.js 20+
• pnpm 10+

Install dependencies:

pnpm install

Run the test suite:

pnpm test

Run the CLI in development:

pnpm dev --help
pnpm dev doctor
pnpm dev doctor --ping
pnpm dev db indexes diff --help
pnpm dev db indexes ensure --help

Build the bundled CLI:

pnpm build

Run the built CLI:

node dist/cli.js --help

npm package behavior

This package publishes a single executable:

• binary name: casectl
• bundled entry: dist/cli.js

After publishing, consumers can run it with:

npx @case-framework/case-cli --help

or install it globally:

npm install -g @case-framework/case-cli
casectl --help

License

Apache-2.0