Categorygithub.com/kyoh86/docbase
modulepackage
0.0.4-beta
Repository: https://github.com/kyoh86/docbase.git
Documentation: pkg.go.dev

# README

docbase

A CLI tool to make the docbase more convenience!

Go Report Card Coverage Status

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

ServiceFunctionImplemented
PostList
PostCreate
PostGet
PostEdit
PostArchive
PostUnarchive
PostDelete
UserList
CommentCreate
CommentDelete
AttachmentUpload
TagList
TagEdit
GroupCreate
GroupGet
GroupList
GroupAddUsers
GroupRemoveUsers
  • 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 to manual and foo to bar)
docbase --token=TOKEN --domain=DOMAIN tag edit howto:manual foo:bar

This tool is still incomplete...

Please contribute to create new functions.

LICENSE

MIT License

This is distributed under the MIT License.