# catj

**Repository Path**: mirrors/catj

## Basic Information

- **Project Name**: catj
- **Description**: catj 是一个可以将 JSON 文件以平铺的格式显示出来的脚本工具
- **Primary Language**: JavaScript
- **License**: MIT
- **Default Branch**: master
- **Homepage**: https://www.oschina.net/p/catj
- **GVP Project**: No

## Statistics

- **Stars**: 4
- **Forks**: 2
- **Created**: 2019-08-22
- **Last Updated**: 2025-12-27

## Categories & Tags

**Categories**: json-tools

**Tags**: None

## README

# catj
Displays JSON files in a flat format.

Input:

``` json
{
  "mappings": {
    "templates": [
      {
        "fields": {
          "mapping": {
            "norms": false,
            "type": "text",
            "fields": {
              "keyword": {
                "ignore_above": 256,
                "type": "keyword"
              }
            }
          }
        }
      }
    ]
  }
}
```

Output:

``` bash
.mappings.templates[0].fields.mapping.norms = false
.mappings.templates[0].fields.mapping.type = "text"
.mappings.templates[0].fields.mapping.fields.keyword.ignore_above = 256
.mappings.templates[0].fields.mapping.fields.keyword.type = "keyword"
```

## Why?

- It makes it easier to understand the structure of JSON files.
- The output is valid JavaScript which can be used directly in code.
- It's very helpful when writing queries for tools like [jq](https://stedolan.github.io/jq/manual/).

## Install

``` bash
npm install -g catj
```

## Usage

``` bash
catj [file]
```

If no file is specified, catj reads from the standard input.

## Version History
+ **1.0**
	+ Initial release.

## Author
**Soheil Rashidi**

+ http://soheilrashidi.com
+ http://twitter.com/soheilpro
+ http://github.com/soheilpro

## Copyright and License
Copyright 2014 Soheil Rashidi

Licensed under the The MIT License (the "License");
you may not use this work except in compliance with the License.
You may obtain a copy of the License in the LICENSE file, or at:

http://www.opensource.org/licenses/mit-license.php

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.