Skip to content

Add CLAUDE.md for AI assistant guidance#2

Draft
adamirving92 wants to merge 1 commit into
mainfrom
claude/claude-md-docs-lkqcje
Draft

Add CLAUDE.md for AI assistant guidance#2
adamirving92 wants to merge 1 commit into
mainfrom
claude/claude-md-docs-lkqcje

Conversation

@adamirving92

Copy link
Copy Markdown
Owner

Summary

Adds a CLAUDE.md file documenting the codebase for AI assistants (and human contributors). No existing CLAUDE.md was present, so this is a new file.

It captures:

  • What the project is — unofficial De'Longhi Pinguino (EL110) control toolkit over the De'Longhi Comfort cloud (Gigya/FIDM → Ayla).
  • The three pieces and how they relate — the aircon Python CLI is the single source of truth; the SwiftBar widget (aircon.30s.py) and Homebridge plugin (index.js) both shell out to it.
  • Architecture / data flow — including the 8-step auth flow and token caching in .tokens.json.
  • Device property conventions — the EL110 read/write property names and value maps, with a note that the mode/fan maps are duplicated between aircon and aircon.30s.py and must be kept in sync.
  • CLI commands, configuration (.env keys, env-var precedence), and dev workflows (npm test smoke test, running each piece).
  • Conventions & constraints — Python 3.10+, dependency-light CLI, executable bits, file co-location assumptions, CommonJS plugin, SwiftBar output format helpers.
  • Security — never commit/print .env or .tokens.json; mask DSNs; doctor is the safe offline diagnostic.
  • Git workflow for this repo.

Testing

Documentation-only change. npm test continues to pass (node --check + Homebridge smoke test).

https://claude.ai/code/session_01RWYJMhgWNt6euXGM9Q5j8E


Generated by Claude Code

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants