Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tippenein/hasken
Easily searchable index of local data -
https://github.com/tippenein/hasken
Last synced: about 1 month ago
JSON representation
Easily searchable index of local data -
- Host: GitHub
- URL: https://github.com/tippenein/hasken
- Owner: tippenein
- License: other
- Created: 2015-02-16T20:12:58.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2016-10-19T21:52:35.000Z (about 8 years ago)
- Last Synced: 2023-03-23T12:09:14.182Z (over 1 year ago)
- Language: Haskell
- Homepage:
- Size: 103 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Hasken
----
[](https://circleci.com/gh/tippenein/hasken)
Easily searchable local document store with option to push to server for backup
Your documents are titled, tagged and stored locally.
> Hasken you shall receive
## Setup
`stack install`
`cp hasken.yml.sample ~/.hasken.yml`
## Usage
```
hasken add shia-magic shia,gif,magic,whatever http://reactiongifs.me/wp-content/uploads/2013/08/shia-labeouf-magic-gif.gif
```
For an explanation of commands
```
hasken add --help bmo@bmos-MacBook-Air-4
Usage: hasken add Title Tag1,Tag2 Content and stuff
Add a document to the local storage
Available options:
-h,--help Show this help text
```
And searchable from the commandline
```
hasken search magic
> shia-magic -> http://reactiongifs.me/wp-content/uploads/2013/08/shia-labeouf-magic-gif.gif
~~| shia gif magic whatever
```
Syncing to/from server
```
hasken sync
```
use it for:
- storing links to gifs
- recipes
- notes
- etc..
## Help
```
$ hasken -h
create and tag documents for searchable recall
Usage: hasken [--version] [--show-tags] [COMMAND]
tagged local storage with a sync option
Available options:
-h,--help Show this help text
--version Show version and exit
--show-tags show tags when displaying documents
Available commands:
add Add a document to the local storage
search search the local docs
list list local docs (defaults to limit 10)
sync sync with the remote
serve serve an instance of the remote component
```
## Config
```yaml
# file: ~/.hasken.yml
remote:
domain: somesite.com
port: 8082
userKey:
local:
showTags: false
```
Feel free to run your own instance of the server with `hasken serve` or connect to a public one with these settings
```yaml
domain: deltadrome.us
port: 8009
```
### remote:
The `sync` option will only push items which are not present on the server, and pull items
the server has exclusively.
### local:
The `showTags` yaml attribute can be overridden by the `--show-tags` flag in any command that displays documents