brew install dataframehq/tap/whale
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.
git clone https://github.com/dataframehq/whale.gitcd whale/make && make install
The Makefile commands don't explicitly add an alias for the
whale binary, so you'll want to add the following alias to your
This method is generally preferred for development as well, as the virtual environment is exposed and modifiable in
We highly recommend installing
bat to enable advanced syntax highlighting (once detected, whale will use
Start by running:
This will assist you in:
Setting up the necessary file structure in
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.
If you instead want to use a git server like github to back your catalog, see Git setup.
To obtain a list of available commands, run:
To run whale's search engine, run: