briandowns / dictum

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

dictum

Dictum is an opinionated package manaager for Dictu.

Usage

NOTE: This repository includes an example Dictu module called slog. It implements a JSON structured logger.

On startup, Dictum will create a top level module directory if it doesn't exist: ${PWD}/dictu_modules .

dictum expects modules to be packaged in a directory that has been tar'd and gzip'd with an extension of .tgz.

Install

By running the command below, dictum will be installed to /usr/local/bin as "dictum" without the ".du" file extension.

sudo make install

Examples

Create a module. The command below will create a new module from the given directory name. The result will be a tar'd and gzip'd file named <module_name.tgz. A dictum.json file will be autogenerated.

dictum create <dir_with_dictu_code>

Install a module. You can install a module from the local file system or from Github. Additionally, if you install from Github you can specify a tag to install.

dictum install <module_name>.tgz
dictum install github.com/briandowns/wanbli
dictum install github.com/briandowns/colorize v0.1.0

When uninstalling modules, Dictum will search the user path for the given module.

dictum uninstall <module_name>

Config

You can provide additional config to dictum by setting a couple environment variables, DICTUM_HTTP_TIMEOUT and DICTUM_HTTP_INSECURE. These will be used when making calls to Github. If a config file exists in the module, you can run the below commands.

Get Informtion on a Module

dictum info <module_name>

Contact

Brian Downs @bdowns328

License

dictum source code is available under the BSD 3 Clause License.

About

License:BSD 3-Clause "New" or "Revised" License


Languages

Language:Makefile 100.0%