project-overview

A technical overview of Kaneo, a self-hosted project-management platform. It describes the project's monorepo structure, where several applications and shared packages live in one repository, and its main technologies.

In plain words
What is it for?
Use it to find project areas and understand the backend, frontend, database, authentication, validation, and deployment setup.
Why use it?
It gives developers a map of the codebase before they change the API, web app, documentation site, deployment files, or shared packages.

Cursor rule for Cursor

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

agentmods
npx agentmods add rules/usekaneo/kaneo/project-overview
Clone the repo
git clone --depth 1 https://github.com/usekaneo/kaneo

Made for: Cursor.

Per session 677 This file is loaded in full into every session.
When invoked 677 The same file — it is already loaded in full.
Security scan A 0 findings. Scan, not verified.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5 $0.00677 $0.00677
Opus 5 $0.00338 $0.00338
Sonnet 5 $0.00135 $0.00135
Haiku 4.5 $0.00068 $0.00068

Measured yesterday against content hash b4d1eb552c47, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

project-overview scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured yesterday.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

.cursor/rules/project-overview.mdc · 85 lines

How it starts

The opening of the file, as written. The whole thing — 85 lines — stays where its author put it; the contents beside it link to each section on GitHub.

Project Overview

Kaneo is a self-hosted project management platform built with a focus on simplicity and performance. This document provides an overview of the project structure and architecture.

Project Structure

Kaneo is organized as a monorepo using pnpm workspaces:

kaneo/
├── apps/
│   ├── api/          # Backend API (Hono/Node.js)
│   ├── docs/         # Documentation site (Next.js)
│   └── web/          # Frontend app (React/Vite)
├── packages/         # Shared code and configs
│   ├── email/        # Email utilities
│   ├── libs/         # Shared libraries
│   └── typescript-config/  # TypeScript configurations
├── charts/           # Kubernetes Helm charts
├── .cursor/          # Cursor IDE rules
└── compose.yml       # Docker Compose configuration

Technology Stack

Backend (API)

  • Framework: Hono (lightweight web framework)
  • Runtime: Node.js
  • Database: PostgreSQL with Drizzle ORM
  • Authentication: Better Auth
  • Validation: Valibot
  • API Documentation: OpenAPI (hono-openapi)
  • Build Tool: esbuild

Frontend (Web)

  • Framework: React 18+
  • Routing: TanStack Router
  • Data Fetching: TanStack Query (React Query)
  • Build Tool: Vite
  • Styling: Tailwind CSS
  • UI Components: Custom component library

Development Tools

  • Package Manager: pnpm
  • Linting/Formatting: Biome
  • TypeScript: Strict mode enabled
  • Git Hooks: Husky

Key Principles

  1. Simplicity First: Features exist to solve real problems, not to impress
  2. Performance: Fast load times and responsive interactions
  3. Self-Hosted: Your data stays yours
  4. Open Source: Free forever, MIT licensed

Development Workflow

  1. Install dependencies: pnpm install
  2. Start development: pnpm dev (starts both API and web)
  3. Lint code: pnpm lint (runs Biome)
  4. Database migrations: pnpm --filter @kaneo/api db:generate and db:migrate

Environment Setup

All environment variables are configured in a single .env file at the project root. See ENVIRONMENT_SETUP.md for detailed configuration instructions.

Read the full file on GitHub · 85 lines

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. yesterday First seen · 85 lines · 677 tokens per session scan A b4d1eb552c47

Subscribe to this mod's changes

project-overview is a cursor rule published in the GitHub repository usekaneo/kaneo (8,786 stars, last pushed yesterday), licensed MIT. It adds 677 tokens to every session, about $0.0034 per session on Opus 5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-30.