Repository navigation
docs(readme): reorganize for end users - #359
Merged
Merged
Conversation
eddietejeda
requested review from
shefeek-jinnah
and removed request for
a team
October 19, 2026 01:41
![claude[bot]](https://avatars.githubusercontent.com/in/1236702?s=60&v=4){kind=small}
| - Authenticate without a browser using an API key: `--api-key <key>`, or | ||
| `HOTDATA_API_KEY` in your environment or a `.env` file. | ||
| - `hotdata query status` and `hotdata ingest run` return exit codes scripts can | ||
| check: `0` done, `1` failed, `2` still running. |
Contributor
There was a problem hiding this comment.
nit: Add exit code 3 for hotdata query status (not blocking).
query status also exits 3 when the query succeeded but the printed result is a truncated preview. src/commands/query.rs:61 defines EXIT_INCOMPLETE_RESULT = 3. The previous README documented exit code 3. A script that follows this list treats exit code 3 as an unknown failure.
Suggested change
| check: `0` done, `1` failed, `2` still running. | |
| check: `0` done, `1` failed, `2` still running. `query status` also returns | |
| `3` when the query is done but the printed result is a truncated preview. |
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Reorganizes the README around what a new user does first: install, quickstart, load data, query. Reference material moves to the end.
catalog.schema.table.-daccepts a name, catalog or id (fix(cli): accept database names and catalogs in every -d flag #280).No commands or behaviour change.