treedoc-cli
TypeScript icon, indicating that this package has built-in type declarations

0.0.4 • Public • Published

GitHub Actions status codecov

treedoc-cli

An interactive CLI tool to explore a treedoc such as JSON, XML. This is a complemental tool to TreeDocViewer GUI. With a CLI tool, it's possible to view very large JSON files which are not possible to be viewed in a GUI tool during to the overhead of UI memory usage. And CLI tool also provides much more powerful scripting capability for auto processing treedoc data.

Background

In my daily job, I often encounter large JSON files 100M files, which is very difficult to be viewed in any GUI JSON viewer. Either crashes the app or very slow to open it. So this tools is try to solve this issue. Without a GUI, it's much more efficient to load large JSON file. The tools mimic a file system a TreeDoc, so that, it allow user to navigation between different nodes using cd command. and show child nodes with ls command which provide pagination, filtering, sorting, aggregation capability. This is a work in progress project. More functions will be added from this basic idea.

Usage

Install & Setup

  • npm install: npm i --global treedoc-cli
  • run it after installed: treedoc-cli
  • npx treedoc-cli
  • Please refer to the help page for the detailed command line options and samples

License

Copyright 2021 TreeDoc.org
Author/Developer: Jianwu Chen

Use of this source code is governed by an MIT-style license that can be found in the LICENSE file or at https://opensource.org/licenses/MIT.

Readme

Keywords

none

Package Sidebar

Install

npm i treedoc-cli

Weekly Downloads

2

Version

0.0.4

License

ISC

Unpacked Size

131 kB

Total Files

63

Last publish

Collaborators

  • jianwu