Skip to content

AGENTS.md

Latest commit

 

History

History
67 lines (55 loc) · 2.29 KB

AGENTS.md

File metadata and controls

67 lines (55 loc) · 2.29 KB
default_branch main
package_manager pnpm
node_version 22.20.0
start_command pnpm run d
dev_command pnpm run dev
build_command pnpm run build
test_commands
pnpm run format
pnpm run lint
pnpm run type-check
pnpm exec vitest run
ports
dev
3000
required_env
optional_env
TELEMETRY_ENABLED
EMDASH_DB_FILE
EMDASH_DISABLE_NATIVE_DB
EMDASH_DISABLE_CLONE_CACHE
EMDASH_DISABLE_PTY
CODEX_SANDBOX_MODE
CODEX_APPROVAL_POLICY

Emdash Agent Guide

Start here. Load only the linked agents/ docs that are relevant to the task.

Start Here

  • Repo map: agents/README.md
  • Setup and commands: agents/quickstart.md
  • System overview: agents/architecture/overview.md
  • Validation flow: agents/workflows/testing.md

Read By Task

  • Main-process changes: agents/architecture/main-process.md
  • Renderer/UI changes: agents/architecture/renderer.md
  • Shared types or provider metadata: agents/architecture/shared.md
  • Worktree behavior or .emdash.json: agents/workflows/worktrees.md
  • SSH or remote project work: agents/workflows/remote-development.md
  • Provider integration or CLI behavior: agents/integrations/providers.md
  • MCP changes: agents/integrations/mcp.md

High-Risk Areas

  • Database and migrations: agents/risky-areas/database.md
  • PTY/session orchestration: agents/risky-areas/pty.md
  • SSH and shell escaping: agents/risky-areas/ssh.md
  • Auto-update and packaging: agents/risky-areas/updater.md

Conventions

  • IPC contract and typing: agents/conventions/ipc.md
  • TypeScript and React norms: agents/conventions/typescript.md
  • Config files and repo rules: agents/conventions/config-files.md

Non-Negotiables

  • Run pnpm run format, pnpm run lint, pnpm run type-check, and pnpm exec vitest run before merging.
  • Do not hand-edit numbered Drizzle migrations or drizzle/meta/.
  • Add renderer typings in src/renderer/types/electron-api.d.ts for any new IPC method.
  • Treat src/main/services/ptyManager.ts, src/main/services/ssh/**, src/main/db/**, and updater code as high risk.
  • Avoid editing dist/, release/, and build/ unless the task is explicitly about packaging or updater/signing behavior.
  • The docs app in docs/ is separate from the Electron renderer and also defaults to port 3000.