kipalog-cli
v0.0.4
Published
Command Line Tool based on Nodejs for Kipalog
Downloads
4
Readme
Kipalog CLI
Command Line Tool based on Nodejs for Kipalog
Installation
Install with npm:
$ npm i -g kipalog-cli
https://www.npmjs.com/package/kipalog-cli
Development and Build
Develop
Install dependencies
npm i
npm i -g babel-core babel-cli
Dev
babel-node index.src.js
Build this project
npm run build
Usage
First time, config your API Key for using this CLI
$ kipalog config
or you can add with command: $ kipalog config <your-api-key>
If you want to change your API key. Set it again with:
$ kipalog config
or $ kipalog config <your-api-key>
Delete your API Key setting:
$ kipalog delete
This CLI use for:
http://kipalog.com
https://github.com/Kipalog/Kipalog-API-Doc
How to get that API:
Upload your post
Write your post in a Markdown file.
Example: README.md
And open your BASH or CMD or anything you can command.
Remember your path of README.md
or just need cd
to the folder containing this file.
$ kipalog post README.md --title "Hello world" --tag "TIL, Nodejs, CSS" --public true
or you can run for draft:
$ kipalog post README.md --title "Hello world" --tag "TIL, Nodejs, CSS"
dont forget, if your path of file has any space, wrap it with '' or "".
Example: "READ ME.md"
Option of kipalog post
command
| option | | value | desciption |
|---|---|---|---|
|--title or -t | requried | string
| title of your post |
|--tag | requried | string
| list of tag, split by comma |
|--public or -p | option | boolean
| publish your post or not (defalut: false
) |
Notice: each option is followed by its value, example: --title "title of post"
.
Preview your post
$ kipalog preview <your-post-path.md> <path-file-will-save-as.html>
Example:
$ kipalog preview readme.md readme.html
Get post from Kipalog
Default: If you dont give path to save file. File will be saved in where you command. Filename default is: timestamp-kipalog-optionname[-tag].json
Hot
Get 30 recent hot post
$ kipalog get --hot [--path=<path-save-response.json>]
Newest
Get 30 recent newest post
$ kipalog get --new [--path=<path-save-response.json>]
Newest
Get 30 recent post by tag.
$ kipalog get --tagby <tagname> [--path=<path-save-response.json>]
Orther options
$ kipalog --help
$ kipalog -h
$ kipalog --version
$ kipalog -v
Copyright and license
Copyright 2016 - 2017 Pierre Neter. Released under the MIT license.