gemlog-cli/README.md

58 lines
1.1 KiB
Markdown

# Gemlog CLI Tool
Quick tool to write gemtext posts for my gemlog.
=> gemini://travisshears.com/gemlog
## Dev
To run command locally:
```shell
$ go run .
```
## Entites
Gemlog
- id, uuid
- title
- slug
- date
- gemtxt
- short? gemtxt < 250 char
## Arch
For DB planning to use couch db
## Use-cases
### Create gemlog entry
Open editor with pre-filled template with frontmatter. Set example date (now), title, slug
### Delete gemlog entry
Select from list then delete.
### Edit gemlog entry
Select from list then edit.
## Creating db
This project is backed by a nosql database, couchdb.
[docs on couchbase permissions and users](https://docs.couchdb.org/en/stable/intro/security.html#users-documents)
Here is how to create the db and give user gemlog-cli access:
```shell
$ curl -X PUT http://admin:xxxxxxxxxxxxxxxxxxxxxxxxxxx@eisenhorn:5023/gemlog
$ curl -X PUT http://admin:xxxxxxxxxxxxxxxxxxxxxxxxxxx@eisenhorn:5023/gemlog/_security \
-H "Content-Type: application/json" \
-d '{"admins": { "names": [], "roles": [] }, "members": { "names": ["gemlog-cli"], "roles": [] } }'
```