Skip to main content

codebase-context

Navigate Homarr's monorepo architecture and reuse shared packages. Use when locating code, choosing a package boundary, understanding runtime services, tRPC, databases, widgets, integrations, cron jobs, Custom Widgets, Workshop, or checking @homarr/common before creating a utility.

Datos de origen

Repositorio
homarr-labs/homarr
Última actividad en el origen
7 de octubre de 2026 a las 14:38
Idioma detectado de SKILL.md
inglés
Estrellas
5069
Forks
332

Opciones de instalación

De forma predeterminada está seleccionado el prompt que primero revisa el origen. Puedes cambiar a un comando directo o descargar una copia local.

Revisa los archivos de origen

Lee SKILL.md y los archivos complementarios que muestra SkillsMP antes de decidir si quieres instalarlo.

Explorador de archivos
4 archivos

Mostrando SKILL.md

SKILL.md
Instrucciones de origen · Vista previa de solo lectura
name
codebase-context
description
Navigate Homarr's monorepo architecture and reuse shared packages. Use when locating code, choosing a package boundary, understanding runtime services, tRPC, databases, widgets, integrations, cron jobs, Custom Widgets, Workshop, or checking @homarr/common before creating a utility.
# Homarr Codebase Context Orient from the current checkout before editing. Treat package manifests, exports, and source as authoritative when they differ from this snapshot. ## Workflow 1. Confirm the branch and inspect the nearest `package.json`, existing sibling modules, and package exports. 2. Search `@homarr/common` before creating a general-purpose helper. Read [references/common.md](references/common.md) for every public entrypoint and export. 3. Read [references/architecture.md](references/architecture.md) when the task crosses packages, runtimes, routing, data, widgets, integrations, cron jobs, Custom Widgets, or Workshop. 4. Keep the change in the deepest package that owns the behavior. Reuse public entrypoints rather than deep-importing implementation files. 5. Re-run targeted searches before documenting counts, consumers, or dependency edges; these change faster than the architectural seams. ## Current toolchain - Use Node `24.18.0` for application runtimes and Bun `1.4.2` for package management, pinned in `mise.toml` and `package.json`. - Use Bun workspaces with Turborepo and a shared hoisted install. Workspace packages use the `@homarr/` scope and catalog-managed dependencies. - Use Next.js App Router, TypeScript, tRPC, Drizzle, Mantine v9, Tabler icons, Jotai, TanStack Query, next-intl, Vitest, and Playwright. - Use oxlint and oxfmt. Mantine is the application UI system; Tailwind is limited to the docs app. - `bun run dev` starts only `@homarr/nextjs`. Start a standalone runtime explicitly when the task needs it. ## High-value seams - Server/RSC tRPC: `@homarr/api/server` - Client tRPC hooks: `@homarr/api/client` - Main router: `packages/api/src/root.ts` - MCP eager router: `packages/api/src/mcp.ts` - Database schemas: `packages/db/schema/{sqlite,postgresql}.ts` - Widget registry: `packages/widgets/src/registry.ts` - Widget loading manifest: `packages/widgets/src/manifest.ts` - Integration definitions: `packages/definitions/src/integration.ts` - Integration factory: `packages/integrations/src/base/creator.ts` - Cron jobs: `packages/cron-jobs/src/jobs/` - App routes: `apps/nextjs/src/app/[locale]/` Invoke `documentation-sync` only when users need new or corrected information to set up, use, or troubleshoot Homarr; follow the Documentation Sync criteria in `AGENTS.md`. When exposing tRPC through MCP, invoke `mcp-integration`.
Ver en GitHub