68 lines
2.2 KiB
Markdown
68 lines
2.2 KiB
Markdown
# MosaicIQ - Claude Code Instructions
|
|
|
|
This is the primary instruction file for Claude Code working on the MosaicIQ project.
|
|
|
|
## Quick Start
|
|
|
|
**Required:**
|
|
```bash
|
|
export PI_API_KEY=your_pi_api_key_here
|
|
```
|
|
|
|
See **[agent.md](./agent.md)** for complete project documentation, including:
|
|
- Full LLM Client Reference with all Pi API functions
|
|
- Monorepo structure and key files
|
|
- Agent behavior guidelines
|
|
- Implementation priorities
|
|
- Coding style and architecture rules
|
|
|
|
## Project Overview
|
|
|
|
**MosaicIQ** is an AI-native equity research workspace built as a local-first desktop application.
|
|
|
|
- **Stack**: TypeScript, React, Electron, SQLite
|
|
- **Architecture**: t3-code-style with typed RPC layer
|
|
- **LLM**: Pi API (Inflection AI) for all AI operations
|
|
- **Monorepo**: PNPM workspace with apps (desktop, web) and shared packages
|
|
|
|
## Dev Server Rules
|
|
|
|
**NEVER start, stop, restart, or manage the dev server.** The user runs the app independently. Your job is to write/edit code and run verification commands (typecheck, lint, tests, build).
|
|
|
|
## File Structure
|
|
|
|
```
|
|
local_research_app/
|
|
├── apps/
|
|
│ ├── desktop/ # Electron main (RPC server, file I/O, DB, agents)
|
|
│ └── web/ # React UI (client)
|
|
├── packages/
|
|
│ ├── contracts/ # Shared TypeScript types
|
|
│ └── shared/ # Shared utilities, LLM client, agents, DB, export
|
|
├── agent.md # Complete project documentation
|
|
└── CLAUDE.md # This file
|
|
```
|
|
|
|
## Key Links
|
|
|
|
| Topic | File |
|
|
|-------|------|
|
|
| Full Documentation | [agent.md](./agent.md) |
|
|
| LLM Client Reference | [agent.md # LLM Client Reference](./agent.md#llm-client-reference) |
|
|
| Architecture | [docs/architecture.md](./docs/architecture.md) |
|
|
| RPC Contracts | [`packages/contracts/src/rpc.ts`](./packages/contracts/src/rpc.ts) |
|
|
| Pi Client | [`packages/shared/src/llm/client.ts`](./packages/shared/src/llm/client.ts) |
|
|
|
|
## Coding Style
|
|
|
|
- TypeScript throughout
|
|
- Small, readable components
|
|
- Explicit state and typed contracts
|
|
- No unnecessary abstractions
|
|
- Follow design tokens from design doc
|
|
- Intentional empty/loading/error states
|
|
|
|
## When Unsure
|
|
|
|
Default to **[agent.md](./agent.md)** or the MosaicIQ Design Document v3 (attached separately).
|