<pre style="font-family: menlo, courier, monospace;">
██▄████▄ ▄████▄ ██ ▄██▀ ▄████▄
██▀ ██ ██▄▄▄▄██ ██▄██ ██▀ ▀██
██ ██ ██▀▀▀▀▀▀ ██▀██▄ ██ ██
██ ██ ▀██▄▄▄▄█ ██ ▀█▄ ▀██▄▄██▀
▀▀ ▀▀ ▀▀▀▀▀ ▀▀ ▀▀▀ ▀▀▀▀
<!-- markdown-toc start - Don't edit this section. Run M-x markdown-toc-generate-toc again -->
**Table of Contents**
- [Web Interface](#web-interface)
- [Add Feed](#add-feed)
- [Crawl Feeds](#crawl-feeds)
- [All Command Line Options](#all-command-line-options)
- [Early 2017](#early-2017)
- [July 2018 -- v0.2](#july-2018----v02)
<!-- markdown-toc end -->
`neko` is a self-hosted, rss reader focused on simplicity and efficiency.
*note: the cat ears are in your mind*
* limited features (#1 feature)
* keyboard shortcuts
* **j** - next item
* **k** - previous item
* that's all you should ever need
* automatically marks items read in an infinite stream of never-ending content (until you run out of content and it ends)
* full text search
* scrapes full text of pages on demand
![Screenshot 1](screenshot/neko.jpg?raw=true "Screenshot 1")
![Screenshot 2](screenshot/neko2.jpg?raw=true "Screenshot 2")
$ go get adammathes.com/neko
This will download `neko`, dependencies, and build them all in `$GOPATH/src/`. By default this should be something like `$HOME/go/src/`.
A `neko` binary should now be in `$GOPATH/bin/`. By default this is usually `$HOME/go/bin/`
There's no configuration file -- everything is handled with a few command line flags. You shouldn't need to change the defaults most of the time.
By default `neko` will create the file `neko.db` in the current directory for storage.
You can override the location of this database file with the `--database` command line option.
$ neko --database=/var/db/neko.db --add=http://trenchant.org/rss.xml
For expert users -- this is a [SQLite](https://sqlite.org/) database and can be manipulated with standard sqlite commands --
$ sqlite3 neko.db .schema
-- will print out the database schema.
## Web Interface
You can do most of what you need to do with `neko` from the web interface, which is what `neko` does by default.
`neko` web interface should now be available at `127.0.0.1:4994` -- opening a browser up to that should show you the interface.
You can specify a different port using the `--http` option.
$ neko --http=9001
If you are hosting on a publicly available server instead of a personal computer, you can protect the interface with a password flag --
$ neko --password=rssisveryimportant
## Add Feed
You can add feeds directly from the command line for convenience --
$ neko --add=http://trenchant.org/rss.xml
## Crawl Feeds
By default `neko` will crawl your feeds every 60 minutes while the interface is running, but if you want to manually crawl from the command line --
$ neko --update
This will fetch, download, parse, and store in the database your feeds.
Export de facto RSS feed standard OPML from the command line with --
$ neko --export=opml
Change `opml` to `text` for a simple list of feed URLs, or `json` for JSON formatted output.
Export is also available in the web interface.
Import of OPML and other things is a TODO item.
# All Command Line Options
View all command line options with `-h` or `--help`
$ neko -h
Usage of neko:
-a, --add http://example.com/rss.xml
add the feed at URL http://example.com/rss.xml
-d, --database string
sqlite database file (default "neko.db")
-x, --export string
export feed. format required: text, json or opml
print usage information
-s, --http int
HTTP port to serve on (default 4994)
rewrite and proxy all image requests for privacy (experimental)
-m, --minutes int
minutes between crawling feeds (default 60)
-p, --password string
password to access web interface
fetch feeds and store new items
* manually initiate crawl/refresh from web interface
* auto-refresh feeds from web interface
* mark all as read
* rewrite frontend in a modern js framework
* prettify interface
* cross-compilation of binaries for "normal" platforms
## Early 2017
I decided I didn't like the [original version of this that was python and mongo](https://github.com/adammathes/neko_v1) so rewrote it. I wanted to learn some Go. So assume the code is not great since I don't know what I'm doing even more so than normal.
## July 2018 -- v0.2
Significant changes to simplify setup, configuration, usage. The goal was typing `neko` should be all you need to do to get started and use the software.
* removed MySQL requirement (eliminating a ton of configuration and complexity)
* added SQLite support (easier!)
* auto-initialization of database file with embedded schema
* removed json-formatted config file -- all options are command line options
* `neko` runs web server by default
* `neko` server crawls feeds regularly rather than requiring cron
Pull requests and issues are welcomed at https://github.com/adammathes/neko