Contributing

​

Prerequisites

• Bun v1.0+
• Node.js v20+ (for the Mintlify CLI only)
• Git

​

Setup

git clone https://github.com/esau-morais/grind
cd grind
bun install
cp .env.example .env
# Edit .env with your vault path and API keys
bun cli init

​

Running Packages

​

Code Style

• 2-space indent, single quotes, semicolons, 100-char line width
• Run bun run format before committing

​

TypeScript Conventions

• exactOptionalPropertyTypes: true is enforced. Never assign undefined to optional properties. Use spread conditionals:
  Copy

  Ask AI

  // Correct
  const obj = { ...(value !== undefined && { prop: value }) };
  
• noUncheckedIndexedAccess: true: always null-check array access
• verbatimModuleSyntax: true: use import type for type-only imports

​

File Organization

• Domain logic → packages/core/src/
• CLI commands → packages/cli/src/commands/
• TUI screens → packages/tui/src/screens/
• Web routes → apps/web/src/routes/

​

Adding a New CLI Command

1. Create packages/cli/src/commands/my-command.ts
2. Export a default async function myCommand() that uses Clack for prompts
3. Register it in packages/cli/src/index.ts

​

Adding a New Agent Tool

1. Define the tool in packages/core/src/agent/tools.ts using the Vercel AI SDK tool() helper
2. Add a permission check if write access is required
3. Add it to the tools object in runAgent
4. Add rendering in packages/tui/src/ChatApp.tsx

​

Adding a Database Table

1. Add the table definition to packages/core/src/vault/schema.ts
2. Run bun run db:generate to create the migration
3. Create a repository in packages/core/src/vault/repositories/
4. Export the repository from packages/core/src/vault/index.ts

​

Documentation

mint dev