#configuration #editor #cli #command-line-tool

app pedit

Command line utility that helps with editing configuration files

1 stable release

1.0.0 Feb 24, 2020

#2420 in Command line utilities

23 downloads per month

MIT license

29KB
703 lines

Latest Version Documentation License

pedit

pedit is a command line utility that helps with automation of editing configuration files.

Features

  • Edits are idempotent which makes the tool suitable for use in administration script and systems like Puppet or Chef.
  • Ensure line in a text file is present or absent.
  • Ensure key-value pair in a text file is present or absent.
  • Key-value pairs can also be defined multiple times with different values (--multikey).
  • Support for relative placement of lines or key-value pairs in respect to existing lines in the text file.
  • Regular expressions are used for matching values in the files.
  • Check mode in which the tool will signal with exit status if change was required without performing any changes.
  • Show changes applied or would be applied in diff style.
  • Tested on MacOS as well as Windows.

Example usage

Ensure that ssh_config file contains key StrictHostKeyChecking set to value yes; if the key is absent put the pair before line containing UserKnownHostsFile.

pedit --in-place ~/.ssh/ssh_config --diff line-pair --separator " " "StrictHostKeyChecking yes" present relative-to "UserKnownHostsFile" before

Installation

cargo install pedit

Dependencies

~9–20MB
~262K SLoC