Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[jo] add README.md #1290

Merged
merged 1 commit into from
Mar 29, 2018
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 39 additions & 0 deletions jo/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
# jo

This package provides the jo binary.

[jo](https://github.com/jpmens/jo) is a utility to create JSON objects on the
command line.

## Maintainers

The Habitat Maintainers humans@habitat.sh

## Type of Package

[binary wrapper package](https://www.habitat.sh/docs/best-practices/#binary-wrapper-packages)

## Usage

```
$ hab pkg install core/jo
$ hab pkg binlink core/jo
$ jo -h
Usage: jo [-a] [-B] [-p] [-v] [-V] [word...]
word is key=value or key@value
-a creates an array of words
-B disable boolean true/false
-p pretty-prints JSON on output
-v show version
-V show version in JSON jo
$ jo -p foo=bar baz=$(jo -a x y z) true@1
{
"foo": "bar",
"baz": [
"x",
"y",
"z"
],
"true": true
}
```