diff --git a/README.md b/README.md index 26baa46..54e5ae9 100644 --- a/README.md +++ b/README.md @@ -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 diff --git a/plugin/.claude-plugin/icon.png b/plugin/.claude-plugin/icon.png new file mode 100644 index 0000000..c19fd97 Binary files /dev/null and b/plugin/.claude-plugin/icon.png differ diff --git a/plugin/README.md b/plugin/README.md new file mode 100644 index 0000000..c43e7a1 --- /dev/null +++ b/plugin/README.md @@ -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 diff --git a/plugin/hooks/check-cli.sh b/plugin/hooks/check-cli.sh index 2e1dfe9..8a40fdf 100755 --- a/plugin/hooks/check-cli.sh +++ b/plugin/hooks/check-cli.sh @@ -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