README
¶
summarizer-cli
This is the cli-companion to the summarizer-frontend. The frontend uses a MeiliSearch instance as data store and search engine.
This CLI can be used to populate this store with your own data. It supports different sources and item types.
Supported Sources
- Github Stars
- All starred projects of a specific user
- Consumes the Github Rest API
- Hacker News Stories
- Hacker News Stories exported with the Materialistic app.
- Checkout the format of the example .txt file at data/hn.txt
- Firefox Bookmarks
- All Firefox Bookmarks exported as a .json file
- Checkout the format of the example .json file at data/bookmarks.json
Usage
Download the binary from the latest job artifact or build it by yourself.
Then run the help command for more information
./summarizer-cli help
To check out the commands and examples for a specific sources run
./summarizer-cli hn help # for Hacker News
./summarizer-cli bm help # for bookmarks
./summarizer-cli gh help # for Github Stars
Troubleshooting
Facet distribution
The UI gets a 400 response with the following message: meili invalid facet distribution, the fields type are not set as filterable.
This means, the type attribute has to be added to the filterable attributes. Read more at: Update filterable attributes
Documentation
¶
Overview ¶
Copyright © 2021 NAME HERE <EMAIL ADDRESS>
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
Source Files
Directories