Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/alexcg1/jfc
Jina Flow Companion - easily search and index from the CLI
https://github.com/alexcg1/jfc
Last synced: 16 days ago
JSON representation
Jina Flow Companion - easily search and index from the CLI
- Host: GitHub
- URL: https://github.com/alexcg1/jfc
- Owner: alexcg1
- License: apache-2.0
- Created: 2022-05-06T10:45:15.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2022-05-23T11:59:42.000Z (over 2 years ago)
- Last Synced: 2024-10-17T08:10:48.946Z (about 1 month ago)
- Language: Python
- Size: 20.5 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# JFC
### Jina Flow Companion
That's right: Jina Flow Companion. Not Jentucky Fried Chicken, or Jesus Fiona Christ.
**Note:** Jina AI doesn't officially support JFC. If you have questions, drop an issue. Don't bother Jina on Slack ;)
## What does it do?
A simple CLI to:
- Index data from a folder, file, text string, CSV, or (coming soon) DocArray on Jina Cloud
- Search data via string or file
It should work with all versions of Jina from 3.0 onwards (prior versions had slightly different APIs)
## Features
- Read config from YAML (coming soon) or command-line arguments
- Connect via REST, gRPC, or WebSocket gateways
### Install
```
pip install jfc
```
### Index
```
jfc index -h https://foo.wolf.jina.ai
```
Where `` is a CSV file or glob
### Search
```
jfc search -h https://foo.wolf.jina.ai
```
Where `` is a file or string
### Other endpoints
Just use arbitrary endpoint name instead of `search` or `index`
For [AnnLiteIndexer](https://hub.jina.ai/executor/7yypg8qk) (and maybe others?):
```
jfc status -h https://foo.wolf.jina.ai # Get index status
jfc clear -h https://foo.wolf.jina.ai # Clear index
```
### Arguments
| Argument | Meaning |
| --- | --- |
| `-h` | URL to host |
| `-n` | Number of documents to index OR return from search |
### Notes
- JFC doesn't do any preprocessing of data. What you input is what you get
- This is alpha-quality software that I built to scratch an itch. Don't expect miracles ;)
- Version number is tied to latest version of Jina it has been tested with. Any number past patch version is the patch version for JFC, not Jina.