https://github.com/dvershinin/sde

Structured data editor for CLI
https://github.com/dvershinin/sde

cli editor json sed utility yaml yml

Last synced: 4 months ago
JSON representation

Structured data editor for CLI

• Host: GitHub
• URL: https://github.com/dvershinin/sde
• Owner: dvershinin
• License: bsd-2-clause
• Created: 2021-06-30T18:10:10.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-05-21T06:56:28.000Z (9 months ago)
• Last Synced: 2024-09-30T23:03:31.086Z (4 months ago)
• Topics: cli, editor, json, sed, utility, yaml, yml
• Language: Python
• Homepage:
• Size: 47.9 KB
• Stars: 17
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
# sde

[![PyPI version](https://badge.fury.io/py/sde.svg)](https://badge.fury.io/py/sde)

`sde` is not `sed`. It's a structured data editor for CLI.

## Why?

Many people asked for a simple JSON in-place editing and `jq` was the solution:

* [Modify a key-value in a json using jq in-place](https://stackoverflow.com/questions/42716734/modify-a-key-value-in-a-json-using-jq-in-place)

* [How to modify a key's value in a JSON file from command line](https://stackoverflow.com/questions/43292243/how-to-modify-a-keys-value-in-a-json-file-from-command-line)

```bash

jq '.address = "abcde"' test.json|sponge test.json

```

    

Does this seem readable or elegant to you?

How about this instead:

```bash

sde address abcde test.json

```

`sde` is not a substitute for `jq` or `sed`.

It allows *simple* in-place JSON/YAML value changes, for *structured* data.

### Sample JSON

```json

{

   "name":"John",

   "age":31,

   "city":"New York",

   "extra": {

       "gender": null

   }

}

```

### Sample YAML

```yaml

database:

  user: example

  password: secret

```

### Modify data

```bash

sde name Jack data.json

sde extra.gender male data.json

sde database.user john data.yml

```

It is possible to modify data in arrays using a dotted notation. Let's take another sample:

```json

{

    "users": [

        {

            "username": "foo", 

            "enabled": true

        },

        {

            "username": "bar", 

            "enabled": true

        }      

    ],

}

```

We can set the first user's `enabled` property to `false`:

```bash

sde users.0.enabled false data.json

```

## Installation for CentOS/RHEL 7, 8 or Amazon Linux 2, or Fedora Linux

```bash

sudo yum -y install https://extras.getpagespeed.com/release-latest.rpm

sudo yum -y install sde

```

   

## Installation for other systems

Installing with `pip` is easiest:

```bash

pip install sde

```

## Notes

### Quoting in JSON

Quoting is avoided for `null`, `true`, `false`, and numeric values.

To ensure that a given value is quoted, use `-s` (or `--string`) option:

```bash

sde -s key null file.json

```

### Force-fail on missing keys

If you must *edit* the file, by ensuring to update only the existing key, use `-e` (`--must-exist`)

option. The program will exit without adding the key which doesn't exist.

```bash

sde -e key val file.json

```

### Force-fail on unchanged file

If the data is unchanged after running `sde` (values already match), you can force

a failure exit code `2` by passing the `-m` option:

```bash

sde -m key sameval file.json

# > exit code 0

sde -m key sameval file.json

# > exit code 2

```

## TODO

### Work with stdin

```bash

echo $json | sde name Jack

```

### Query simple data

```bash

sdg name data.json

```