Repository navigation
README: simplify and focus on the plugin - #1
eddietejeda wants to merge 3 commits into
Conversation
|
|
||
| **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 |
There was a problem hiding this comment.
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:
| 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. |
There was a problem hiding this comment.
Review — Blocking Issues
README.md:14: The Install section omits thehotdataCLI prerequisite. The plugin runs thehotdatabinary for every operation (scripts/hotdata.py:44-49). Login useshotdata auth login(scripts/api.py:23). A user without the CLI gets an error on everyhdcommand.
Action Required
- State in the Install section that the
hotdataCLI must be onPATHand logged in. - Remove "Nothing else to set up." or keep it only after the CLI requirement.
| 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. |
There was a problem hiding this comment.
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.
| 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. |
There was a problem hiding this comment.
Review
Blocking Issues
- README.md:14-16: The install section does not name the
hotdatabinary as a requirement.scripts/hotdata.py:44-49runs thehotdatabinary for every database operation. A user with an account but without the binary onPATHgets a failure on everyhd loadandhd query.
Action Required
- State that the
hotdataCLI must be onPATHand logged in. - Confirm that
hotdata-cli@hotdatainstalls the binary. Ifhotdata-cli@hotdatadoes not install the binary, link to the CLI install instructions.
Rewrites the README for developers using the plugin.