Nifty Penguin Magic

    github-kv

    1.1.0 • Public • Published

    GitHub Key-Value Store

    npm version

    GitHub as a Key Value store.

    한국어 안내

    Installation

    npm install -g github-kv

    Caveat

    When create new Personal Access Token, You should check only repo.

    Usage

    Example key-value store

    please show store.json in this repo.

    {
        "ACCESS_KEY": "HELLO",
        "SECRET_KEY": "WORLD"
    }

    Global CommandLine Interface

    in Terminal. extract is optional

    # gh-kv --token <GitHub Token> \ 
    #         --owner <Owner or Organization> \ 
    #         --repo <REPO_NAME> \ 
    #         --file <TARGET_FILENAME> \ 
    #         --extract <OUTPUT_FILENAME> \ 
    #         --webhook <WEBHOOK_POST_URL> 
    gh-kv --token <GitHub Token> --owner changjoo-park --repo kv --file store.json --extract key.json

    Module in Node.js

    extract is optional same as global CLI

    const getGitHubStore = require('github-kv')
     
    // Promise
    getGitHubStore({ token, owner, repo, file, extract })
        .then(store => {})
        .catch(error => {})
     
    // async - await
    const store = await getGitHubStore({ token, owner, repo, file, extract })

    Install

    npm i github-kv

    DownloadsWeekly Downloads

    0

    Version

    1.1.0

    License

    MIT

    Unpacked Size

    6.06 kB

    Total Files

    7

    Last publish

    Collaborators

    • changjoo-park