Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 2 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -201,24 +201,8 @@ Use either the plugin or the installer's skill, not both: if you installed the
CLI with the script above, install it with `HOTDATA_NO_SKILLS=1` or Claude Code
will list the skill twice.

What the plugin runs, sends, and fetches:

- **SessionStart hook** (`plugin/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 this repository's GitHub 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 this
repository's GitHub releases for new versions (`HOTDATA_NO_UPDATE_CHECK=1`
turns that off). Neither the plugin nor the CLI collects telemetry.
For what the plugin runs, sends, and fetches, see
[`plugin/README.md`](plugin/README.md#what-the-plugin-runs-sends-and-fetches).

## Getting help

Expand Down
Binary file added plugin/.claude-plugin/icon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
38 changes: 38 additions & 0 deletions plugin/README.md
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.
Comment on lines +11 to +29

Copy link
Copy Markdown
Contributor

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 to plugin/README.md. The two lists are now near-identical copies. A future change to check-cli.sh or the installer flow must update both copies, or the disclosures drift apart.


## 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
10 changes: 4 additions & 6 deletions plugin/hooks/check-cli.sh
Original file line number Diff line number Diff line change
Expand Up @@ -26,10 +26,8 @@ if [ -x "$DIST_BIN_DIR/hotdata" ]; then
exit 0
fi

cat <<'EOF'
The hotdata CLI is not installed. Before running any hotdata command, tell the
user and ask whether to install it. If they agree, follow the install steps in
the hotdata skill (the "Upgrade" section of skills/hotdata/SKILL.md), and set
HOTDATA_NO_SKILLS=1 because this plugin already provides the skill.
EOF
echo 'The hotdata CLI is not installed. Before running any hotdata command, tell the'
echo 'user and ask whether to install it. If they agree, follow the install steps in'
echo 'the hotdata skill (the "Upgrade" section of skills/hotdata/SKILL.md), and set'
echo 'HOTDATA_NO_SKILLS=1 because this plugin already provides the skill.'
exit 0
Loading