remove-json-keys 1.8.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=app_DESC,err_NOT_FOUND
--config	Use custom config file	--config=path/to/file
init, -i, --init	Create .remove-json.config.json5 in project root to store default settings
-n, --no-wizard	Skip interactive prompts during start-up
-h, --help	Show help screen
-v, --version	Show version
-V, --debug [targetConfigKey]	Show debug logs
--docs	Open docs URL

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 -n --keys=err_NOT_FOUND --json-dir=messages  # no prompts

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

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

Config file

Run remove-json 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.

Back to top ↑