README
¶
Starship
Starship is a private document search engine for internal information. It currently supports indexing any type of text based document, and uses machine intelligence to provide a modern search experience.
Getting Started
To get started with setting up your own instance of Starship, visit the documentation at www.starship.fyi.
Example Usage
Searching Documents
Indexing Documents
Starship CLI
A command line application is available for connecting to and interacting with a Starship instance. Visit the Starship CLI Repo for more information.
License
Starship is provided under the Apache 2.0 License.
Contributing
If there is something you want fixed, added, or changed, feel free to submit an issue/pull request.
See CONTRIBUTING.md for a full guide on how you can help.
Setup Starship For Local Development
Some preliminary setup is required before you'll be able to work on Starship in a local development environment. An exhaustive guide on running Starship is available at the Starship documentation website.
Directories