This is the site for the beta version of Stork Search. Take me back to stable!

Install Stork

Pre-built binaries

You can download a pre-built binary to run Stork from the command line. You can either download the binary from the appropriate Github Release or from the Stork CDN.

Pre-built Stork binaries are available for the following platforms:

  • macOS (x64, macOS 11)
  • macOS (x64, macOS 12)
  • macOS (Apple Silicon)
  • Linux (Ubuntu 20.04)
  • Linux (Ubuntu 22.04)
  • Amazon Linux

macOS users can also use Homebrew to install Stork:

$ brew install stork-search/stork-tap/stork

Build from source

If you have a current Rust toolchain installed, you can use Cargo to build Stork from source.

$ cargo install stork-search

Note:

If these options don't work for you, please file a Github issue describing the installation process you hope to see.

Next Steps

  • Install the Javascript library
  • Build a search index
Was this page helpful?

Documentation Preferences

These options let you customize the documentation based on how you want to use Stork.

Installation Method

Configuration File Format

Document Source

© 2019–2023.

Stork is maintained by James Little, who's really excited that you're checking it out.

This site is open source. Please file a bug if you see something confusing or incorrect.

Logo art by Bruno Monts, with special thanks to the fission.codes team.
Please contact James Little before using the logo for anything.