Skip to content

README: simplify and focus on the plugin - #1

Closed
eddietejeda wants to merge 3 commits into
masterfrom
docs/simplify-readme
Closed

eddietejeda wants to merge 3 commits into
masterfrom
docs/simplify-readme

Conversation

@eddietejeda

Copy link
Copy Markdown
Contributor

Rewrites the README for developers using the plugin.

  • Install, how it works, commands, configuration, SQL dialect, limits, develop.
  • Drops references to the Hotdata CLI and to plugin versions.
  • Benchmark cut to a plugin vs no-plugin table.

Comment thread README.md Outdated

**One database per project.** The project is named by its repository root, so every
agent in the repo resolves the same database; a `project` option pins the name.
You need a Hotdata account, logged in on the machine. The first `hd load` creates the

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Blocking: List the hotdata CLI as a required install step. Remove "Nothing else to set up."

The plugin shells out to the hotdata binary for every database operation. scripts/hotdata.py:44-49 runs ["hotdata", *args]. The same file raises "the hotdata CLI is not on PATH" when the binary is missing. Login also goes through the CLI: scripts/api.py:23 tells the user to run hotdata auth login.

Failure scenario: a user follows this README on a machine without the CLI. Every hd load and hd query then fails. The SessionStart hook prints only a systemMessage error.

Suggested text:

Suggested change
You need a Hotdata account, logged in on the machine. The first `hd load` creates the
You need the `hotdata` CLI on `PATH`, logged in with `hotdata auth login`. The first `hd load` creates the
project's database. Nothing else to set up.

@claude claude Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Review — Blocking Issues

  • README.md:14: The Install section omits the hotdata CLI prerequisite. The plugin runs the hotdata binary for every operation (scripts/hotdata.py:44-49). Login uses hotdata auth login (scripts/api.py:23). A user without the CLI gets an error on every hd command.

Action Required

  • State in the Install section that the hotdata CLI must be on PATH and logged in.
  • Remove "Nothing else to set up." or keep it only after the CLI requirement.

Comment thread README.md Outdated
Comment on lines +14 to +16
You need a Hotdata account, logged in on the machine. If you have not set that up,
install `hotdata-cli@hotdata` from the same marketplace first. It walks you through the
login. The first `hd load` creates the project's database. Nothing else to set up.

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Blocking: Name the hotdata binary as a requirement. The text still names only an account and a login.

scripts/hotdata.py:44-49 runs the hotdata binary for every database operation. A user can hold a Hotdata account and an API key without that binary on PATH. That user skips the hotdata-cli@hotdata step. Every hd load then fails with "the hotdata CLI is not on PATH".

Apply this text only if hotdata-cli@hotdata installs the hotdata binary. Otherwise, link to the CLI install instructions.

Suggested change
You need a Hotdata account, logged in on the machine. If you have not set that up,
install `hotdata-cli@hotdata` from the same marketplace first. It walks you through the
login. The first `hd load` creates the project's database. Nothing else to set up.
You need the `hotdata` CLI on `PATH`, logged in. If you do not have it, install
`hotdata-cli@hotdata` from the same marketplace first. That plugin walks you through the
login. The first `hd load` creates the project's database.

@claude claude Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Review

Blocking Issues

  • README.md:14-16: The install section does not name the hotdata binary as a requirement. scripts/hotdata.py:44-49 runs the hotdata binary for every database operation. A user with an account but without the binary on PATH gets a failure on every hd load and hd query.

Action Required

  • State that the hotdata CLI must be on PATH and logged in.
  • Confirm that hotdata-cli@hotdata installs the binary. If hotdata-cli@hotdata does not install the binary, link to the CLI install instructions.

@eddietejeda

Copy link
Copy Markdown
Contributor Author

Superseded by #5 and #6: the README now reflects v4 (tabular-memory command) and lists what the plugin runs, sends, and fetches for the plugin directory. This branch conflicts with master and still uses the old hd name.

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