Repository navigation
docs(plugin): add a README inside the plugin folder #364
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,38 @@ | ||
| # Hotdata CLI plugin | ||
|
|
||
| This plugin teaches Claude to use the [Hotdata](https://www.hotdata.dev) CLI. | ||
| With it, Claude can manage workspaces and databases, run SQL, pull data in from | ||
| other sources with ingests, build full-text and vector search indexes, run | ||
| analytics, and work with geospatial data. | ||
|
|
||
| The plugin ships the `hotdata` skill. It does not ship the CLI binary. If the | ||
| CLI is missing, Claude asks before it installs anything. | ||
|
|
||
| ## What the plugin runs, sends, and fetches | ||
|
|
||
| - **SessionStart hook** (`hooks/check-cli.sh`, Claude Code and Cowork only): | ||
| checks whether `hotdata` is on `PATH` or in `~/.hotdata/cli`. If it's only in | ||
| `~/.hotdata/cli`, it adds that folder to `PATH` for the session. If it's | ||
| missing, it asks Claude to offer to install the CLI. The hook makes no | ||
| network requests, installs nothing, and sends no data. | ||
| - **Installer**, only after you agree: `brew install hotdata-dev/tap/cli` when | ||
| `brew` is present. Otherwise Claude downloads `https://hotdata.dev/install` to | ||
| a file, shows it to you, and runs it with `HOTDATA_NO_SKILLS=1`. It installs | ||
| the CLI from the | ||
| [hotdata-cli GitHub releases](https://github.com/hotdata-dev/hotdata-cli/releases). | ||
| - **The skill** teaches Claude to run `hotdata` commands. Those commands talk to | ||
| the Hotdata API (`https://api.hotdata.dev/v1`, or `HOTDATA_API_URL`) with your | ||
| Hotdata credentials, and send the queries, files, and data source settings | ||
| you ask Claude to work with. `hotdata auth login` opens | ||
| `https://app.hotdata.dev` in your browser, and the CLI checks the hotdata-cli | ||
| GitHub releases for new versions (`HOTDATA_NO_UPDATE_CHECK=1` turns that off). | ||
| Neither the plugin nor the CLI collects telemetry. | ||
|
|
||
| ## Links | ||
|
|
||
| - [Documentation](https://www.hotdata.dev/docs) and the | ||
| [CLI reference](https://www.hotdata.dev/docs/cli-reference) | ||
| - [Source](https://github.com/hotdata-dev/hotdata-cli) | ||
| - [Privacy policy](https://www.hotdata.dev/privacy-policy) and | ||
| [terms of service](https://www.hotdata.dev/terms-of-service) | ||
| - License: MIT | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nit: Keep one copy of this disclosure section (not blocking).
Replace the "What the plugin runs, sends, and fetches" list in the root
README.md(lines 204-221) with a link toplugin/README.md. The two lists are now near-identical copies. A future change tocheck-cli.shor the installer flow must update both copies, or the disclosures drift apart.