Skip to content

README: list what the plugin runs, sends, and fetches - #6

Merged
eddietejeda merged 2 commits into
masterfrom
readme-disclosure
Oct 27, 2026
Merged

eddietejeda merged 2 commits into
masterfrom
readme-disclosure

Conversation

@eddietejeda

Copy link
Copy Markdown
Contributor

The directory asks whether a plugin sends data to other services and
expects the answer in the README.

The directory asks whether a plugin sends data to other services and
expects the answer in the README.
Comment thread README.md Outdated
`~/.hotdata/api-key` when the environment has none, and sends it nowhere else.
- **SessionStart hook.** It runs `hotdata auth status` once per machine, prints the
cached orientation, and refreshes that cache in the background: CLI calls read the
project's tables and a sample of rows, and the saved-query API reads its definitions. The cache lives in

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: Add the project's recent query history and date ranges to this list. (not blocking)

The refresh does more than this sentence says. orient.recent_results calls hotdata.query_runs and writes up to six past SQL statements, with their result ids, into the local cache. hotdata.ranges also reads the min and max of date columns. A reader who checks what lands on disk will find SQL text that this section does not mention.

Suggested wording: "CLI calls read the project's tables, a sample of rows, date ranges, and recent query history, and the saved-query API reads its definitions."

claude[bot]
claude Bot previously approved these changes Oct 27, 2026
@eddietejeda
eddietejeda merged commit bfc0df9 into master Oct 27, 2026
1 check passed
@eddietejeda
eddietejeda deleted the readme-disclosure branch October 27, 2026 22:54
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.

1 participant