swiss-json

Quickly manipulate JSON file values from the command line

• swiss-json

Commands

• json copy SRC
• json del [FILE]
• json format [FILE]
• json get PATH [ACCESSOR]
• json help [COMMAND]
• json json merge [...flags] <src>[:[accessor]] <dest>[:[accessor]]
• json set [FILE]

json copy SRC

Copy a value, object, or whole file (as stringified JSON) to the device clipboard.

USAGE
  $ json copy SRC

ARGUMENTS
  SRC
      Path to the source JSON file.
         Access properties within the data by appending the full JSON path in dot-notation (the "accessor") to the file 
      path, delimited by ":" -- {file}:{accessor}
         Providing a key with -k, --key=<key> will cause the inline accessor to be treated as part of the file name.
         Property names need not be bracketed as they would in a script file.
         - For example, the following is a valid accessor: "./package.json:config.json-edit"

OPTIONS
  -h, --help     show CLI help

  -k, --key=key  Designate the property accessor/key path string. May access nested properties by using dot-notation.
                 For example,
                 --key="property.nested-property" will allow access to the "nested-property" field within the
                 object at "property

  -p, --pretty   Format the copied text with line breaks and indentation.

  -q, --quiet    Do not print the JSON content to stdout after successful copy.

See code: src\commands\copy.ts

json del [FILE]

describe the command here

USAGE
  $ json del [FILE]

OPTIONS
  -V, --verbose  Enable verbose output:
                 - Prints full JSON structure, with edits made.

  -h, --help     show CLI help

  -k, --key=key  (required) Designate the property accessor/key path string. May access nested properties by using
                 dot-notation. For example,
                 --key="property.nested-property" will allow access to the "nested-property" field of "property"

  -y, --yes      Skip confirmation and remove the property from the JSON structure

See code: src\commands\del.ts

json format [FILE]

Format the data and write formatted contents in-place.

USAGE
  $ json format [FILE]

OPTIONS
  -h, --help           show CLI help
  -i, --indent=indent  [default: 2] Specify the number of spaces to use for indentation levels. Defaults to 2.
  -t, --tabs           Use a tab character ("\t") for indentation.

See code: src\commands\format.ts

json get PATH [ACCESSOR]

Inspect a full JSON file, or specific property within.

USAGE
  $ json get PATH [ACCESSOR]

ARGUMENTS
  PATH      An absolute or relative path pointing to a JSON file

  ACCESSOR  Property to retrieve from the file. May use dot-notation to reference nested values. If omitted, the full
            JSON object is printed.

OPTIONS
  -h, --help  show CLI help
  --no-color  Control use of ANSI colors in stdout.

See code: src\commands\get.ts

json help [COMMAND]

display help for json

USAGE
  $ json help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

json json merge [...flags] <src>[:[accessor]] <dest>[:[accessor]]

Extract a property or whole JSON object from [src] file, and assign it to a property of (or overwrite entirely) [dest] file.

USAGE
  $ json json merge [...flags] <src>[:[accessor]] <dest>[:[accessor]]

ARGUMENTS
  SRC   Path of source file. To reference a property or nested properties, append the full JSON path in dot-notation
        (the "accessor") to the file path, delimited by ":" - ex: {file}:{accessor}

  DEST  Destination for the value obtained from [src]. Creates a new file if destination does not exit. To reference a
        property or nested properties, append the full JSON path in dot-notation (the "accessor") to the file path,
        delimited by ":" - ex: {file}:{accessor}

OPTIONS
  -f, --overwrite                                             Overwrite existing files, instead of merging onto the root
                                                              of the desination object. Same effect as "json graft
                                                              --no-merge <src>[:[accessor]] <dest>"

  -h, --help                                                  show CLI help

  --no-merge                                                  When both [src]:<accessor> and [dest]:<accessor> refer to
                                                              properties containing nested properties, overwrite the
                                                              full destination object with the source object instead of
                                                              merging the properties into a single object.

  --no-recursion                                              Apply the merge strategy to top-level properties only.

  --strategy=replace|combine|replace-recurse|combine-recurse  Designate the merge strategy for nested object properties

ALIASES
  $ json copy
  $ json cp
  $ json cpy

See code: src\commands\merge.ts

json set [FILE]

DESCRIPTION

USAGE
  $ json set [FILE]

OPTIONS
  -V, --verbose      Enable verbose output:
                     - Prints full JSON structure, with edits made.

  -h, --help         show CLI help

  -k, --key=key      (required) Designate the property accessor/key path string. May access nested properties by using
                     dot-notation. For example,
                     --key="property.nested-property" will allow access to the "nested-property" field within the
                     object at "property"

  -v, --value=value  (required) Designate the new value. Values will be de-serialized with JSON.parse; For example,
                     --value "{ \"key\": \"value\" }"

DESCRIPTION
  Set the value for a new or existing property key in a JSON file.

See code: src\commands\set.ts