remove-json-keys 1.2.0

Simply remove JSON keys via CLI command.

> remove-json-keys

Simply remove JSON keys via CLI command.

Installation

pip install remove-json-keys

Usage

Run the CLI:

remove-json-keys [options] # or remove-json

If no options are passed, the CLI will:

1. Prompt for keys to delete
2. Auto-discover closest child json_dir
3. Delete keys from found JSON files

Note: Key/values can span multiple lines and have any amount of whitespace between symbols.

Options

Options can be set by using command-line arguments:

Option	Description	Example
-d, --json-dir	Name of the folder containing JSON files (default: _locales)	--json-dir=data
-k, --keys	Comma-separated list of keys to remove	--keys=appDesc,err_notFound
-i, --init	Create .remove-json.config.json5 in project root to store default settings
-W, --no-wizard	Skip interactive prompts during start-up
-h, --help	Show help screen

Examples

Remove author key from JSON files found in default _locales dir:

remove-json-keys --keys=author # prompts for more keys to remove

Remove info_SUCCESS key from JSON files found in messages dir:

remove-json-keys --keys=err_NOT_FOUND --json-dir=messages -W # no prompts

Remove app_DESC + app_VER keys from JSON files found in data dir:

remove-json -k app_DESC,app_VER -d data -W # no prompts

Config file

Use --init to create .remove-json.config.json5 in your project root to set default options.

Example defaults:

{
  "json_dir": "_locales", // name of the folder containing JSON files
  "keys": "",             // keys to remove (e.g. "app_NAME,author")
  "force": false,         // force overwrite existing config file when using --init
  "no_wizard": false      // skip interactive prompts during start-up
}

Note: CLI arguments always override config file.

MIT License

Copyright © 2023–2026 Adam Lui.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Back to top ↑