Getting started
Last updated
Was this helpful?
Last updated
Was this helpful?
Welcome to the official docs for whale! Whale is an open-source CLI-based data discovery and SQL-runner built and maintained by .
You'll need to have rust installed for the following commands to work.
.
If you are not on macOS (or are looking to build whale from source for development purposes), you should (a) clone the whale repository and run (b)make && make install
in the base directory of the repo.
The Makefile commands don't explicitly add an alias for the whale
binary, so you'll want to add the following alias to your .bash_profile
or .zshrc
file.
This method is generally preferred for development as well, as the virtual environment is exposed and modifiable in ~/.whale/libexec/env
.
Start by running:
This will assist you in:
Setting up the necessary file structure in ~/.whale
.
Setting up your warehouse connection credentials.
Registering a cron job in your crontab
, so whale can periodically scrape metadata.
Once that is complete, either wait for the cron job to run, or run wh pull &
to manually kick off a job in the background, if you're feeling impatient.
To obtain a list of available commands, run:
To run whale's search engine, run:
We highly recommend installing to enable advanced syntax highlighting (once detected, whale will use bat
over cat
automatically).
If you instead want to use a git server like github to back your catalog, see .