own-planner: Instructions file for Codex

AGENTS.md

This file provides guidance to Codex (Codex.ai/code) when working with code in this repository.

Overview

OwnPlanner is an AI-powered personal planning assistant: a layered .NET 10 solution with a React + TypeScript (Vite, MUI) frontend. Users chat with a Google Gemini LLM that invokes in-process MCP-style tools to manage tasks, notes, goals, and contexts stored in per-user SQLite databases.

Common commands

Run from the repo root unless noted.

# Install/restore dependencies, then run the full local CI-equivalent verification
./scripts/setup.sh
./scripts/verify.sh

# Verify only one stack
./scripts/verify.sh --backend
./scripts/verify.sh --frontend

# Single test project, class, or method
dotnet test --project OwnPlanner.Application.Tests/OwnPlanner.Application.Tests.csproj
dotnet test --project OwnPlanner.Domain.Tests --filter-class "OwnPlanner.Domain.Tests.Tasks.TaskItemTests"
dotnet test --project OwnPlanner.Domain.Tests --filter-method "*Ctor_Valid_SetsProperties"

# Run the web server (auto-launches the Vite dev server via SpaProxy)
dotnet run --project OwnPlanner.Web/OwnPlanner.Web.Server   # http://localhost:5079

# Run the console chat loop (type `exit` to quit)
dotnet run --project OwnPlanner.Console

Frontend (from OwnPlanner.Web/ownplanner.web.client/):

npm ci
npm run dev      # Vite dev server
npm run build    # tsc -b && vite build
npm run lint     # eslint

CI (.github/workflows/ci.yml) uses the same scripts: scripts/setup.sh, then frontend and backend verification. Run ./scripts/verify.sh before pushing to match both verification paths locally.

Git workflow

• Never commit directly to master.
• Before the first task commit, create or switch to a dedicated branch. Unless the user specifies another name, use feature/<short-description> for enhancements and fix/<short-description> for bug fixes.
• Keep unrelated staged or working-tree changes out of task commits.
• Open a pull request targeting master when the work is ready for review.