# README
docbase
A CLI tool to make the docbase more convenience!
Install
go get github.com/kyoh86/docbase
Usage
docbase --help
Required:
Pass a API token with --token=TOKEN
flag or an environment variable DOCBASE_API_TOKEN
, and domain (i.e. DOMAIN.docbase.io) with --domain=DOMAIN
flag or the envar DOCBASE_DOMAIN
.
Functions
Coverage Status
Service | Function | Implemented |
---|---|---|
Post | List | ☑ |
Post | Create | ☐ |
Post | Get | ☑ |
Post | Edit | ☐ |
Post | Archive | ☐ |
Post | Unarchive | ☐ |
Post | Delete | ☐ |
User | List | ☐ |
Comment | Create | ☐ |
Comment | Delete | ☐ |
Attachment | Upload | ☐ |
Tag | List | ☑ |
Tag | Edit | ☑ |
Group | Create | ☐ |
Group | Get | ☐ |
Group | List | ☐ |
Group | AddUsers | ☐ |
Group | RemoveUsers | ☐ |
- List Posts
docbase --token=TOKEN --domain=DOMAIN post list [--query <QUERY>] [--format <FORMAT>] [--page <PAGE>] [--per-page <PER_PAGE>]
- Get a post
docbase --token=TOKEN --domain=DOMAIN post get <POST_ID>
- List tags
docbase --token=TOKEN --domain=DOMAIN tag list
- Edit tags (i.e. all
howto
tags tomanual
andfoo
tobar
)
docbase --token=TOKEN --domain=DOMAIN tag edit howto:manual foo:bar
This tool is still incomplete...
Please contribute to create new functions.
LICENSE
This is distributed under the MIT License.