---
title: Maribelle
---

Maribelle (hereinafter the "Application") is a Discord bot that allows you to configure daily progress huddle reminders for your server members.

## 1. User Documentation

The Application posts weekday stand-up prompts in configured Discord text channels and tracks which members posted progress updates in the previous cycle.

Current reminder schedule in the source is `0 9 * * 1-5` (09:00, Monday through Friday).

During operation, the Application:

1. Sends a stand-up reminder message in each configured channel.
2. Starts a thread named `Daily Progress Update - <date>`.
3. Monitors messages in those threads and records participant IDs.
4. Sends a summary of recorded IDs to the maintainer account before the next cycle.

Channel and role mappings are configured in `src/config/channels.ts`.

## 2. Technical Documentation

The Application is a Node.js + TypeScript Discord bot using `discord.js` and `node-schedule`.

Runtime and build commands from `package.json`:

1. `pnpm install`
2. `pnpm build`
3. `pnpm start`

The startup command runs with `op run --env-file=prod.env`, so local operation expects a `prod.env` file and 1Password CLI access.

Minimum environment variables for runtime include:

1. `DISCORD_TOKEN` for bot authentication.
2. `LOG_WEBHOOK_URL` for logger transport.

Key implementation files:

1. `src/index.ts` bootstraps the Discord client, schedules reminders, and listens for thread messages.
2. `src/modules/standup.ts` sends reminders, opens threads, and reports participant IDs.
3. `src/config/channels.ts` defines target channel/role pairs.

## 3. Legal Documentation

The Application inherits the nhcarrigan global legal documents:

1. Privacy Policy: https://docs.nhcarrigan.com/#/privacy
2. Terms of Service: https://docs.nhcarrigan.com/#/terms
3. License: https://docs.nhcarrigan.com/#/license

Repository references:

1. `PRIVACY.md`
2. `TERMS.md`
3. `LICENSE.md`

## 4. Contributing Documentation

Contribution guidance for the Application points to the shared documentation:

1. https://docs.nhcarrigan.com/#/contributing

Project metadata currently reports version `0.0.0` in `package.json`, which aligns with an unreleased/early state.

