Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/muonw/muonw-ezconfig.sh


https://github.com/muonw/muonw-ezconfig.sh

Last synced: 5 days ago
JSON representation

Awesome Lists containing this project

README 

        
# 💻 ezconfig.sh



ezconfig.sh is a bash script that facilitates editing the plaintext config files with key/value format.



## ⚡️ Quick start



Install by running this command in your terminal:



```sh

bash <(wget -qO- https://raw.githubusercontent.com/muonw/muonw-ezconfig.sh/main/installer.sh)

```



If your Linux distro does not come with `xxd` out of the box, make sure to install it:



```sh

# Example installation for Debian

apt install xxd

```



## 📖 Manual



```sh

ezconfig.sh (File) (Operation) (Key) [Connector] (Value)

```



`File` is the plaintext configuration file you would like to modify.



`Operation` can be one of the following options:

  - `add` attemps to add a key/value set to the end of the file if it doesn't already exist. If the set exists, it will be overwritten. Most useful when the key is not supposed to be unique (e.g. adding `127.0.0.1  secondlocal` to the `hosts` file)

  - `set` first attempts to update the value of the last preexisting key that is NOT commented out by `#`. If a matching key does not exist, a new key/value set will be added to the end of the file. Most useful when the key is supposed to be unique (e.g. setting the SSH port number)

  - `reset` is like `set` but first attempts to uncomment and modify the value of the already available key in place if they are commented out by `#`.

  - `autoset` is like `set` but does not prompt you if finds multiple matches. Instead, modifies the last one.

  - `autoreset` is like `reset` does not prompt you to confirm the replacement and if finds multiple matches, modifies the last one.



`Key` is the first part of a key/value set.



`Connector` is the character that should be placed between the key and value. The default is space.



`Value` is the second part of a key/value set.



## 👀 Examples



### Example 1. Setting the PHP memory limit to 2G



```

ezconfig.sh ./php.ini set memory_limit = 2G

```



Output:

```

> Matches before the processing:

401:memory_limit = -1

> Matches after the processing:

401:memory_limit=2G

```

Tip: you can put quotations around the arguments to modify the spacing! For example `ezconfig.sh ./php.ini set memory_limit ' = ' 2G` would generate `memory_limit = 2G`. Notice that line numbers of the matches are shown in the output.



### Example 2. Setting the SSH port number to 22 in the config file /etc/ssh/sshd_config



By default, the port number line in /etc/ssh/sshd_config is commented out (`#Port 22`). So, instead of using `set` that adds the setting to the end of the file, we can use `reset` to uncomment and modify the preexisting setting in place (if `reset` cannot find a match, it will act like `set`).



```

ezconfig.sh /etc/ssh/sshd_config reset Port ' ' 5492

```



Or, since the default `Connector` is a space character, simply...



```

ezconfig.sh /etc/ssh/sshd_config reset Port 5492

```



Output:

```

> Matches before the processing:

15:#Port 22

> I can uncomment and modify the matched instance. Would you like to continue? (y/n)

```

Now we hit the `y` key to agree (if you wish to automatically confirm such actions, you can use `autoreset` instead of `reset`). 

```

> Matches after the processing:

15:Port 5492

```

The reason `reset` prompts you is that it cannot distinguish between a **comment** and a **commented out key/value set**. In this case, a line that contains `#Port should be set below` is as likely to be affected as `#Port 22` and you may lose the content of the comments.



### Example 3. Exporting variables



```

MY_TIMEZONE='America/New_York'

ezconfig.sh ~/.bashrc set 'export APP_TIMEZONE' = "'${MY_TIMEZONE}'"

```

Output:

```

> Matches after the processing:

114:export APP_TIMEZONE='America/New_York'

```



### Example 4. Updating the hostname in the hosts file

```

hostnamectl set-hostname "NewServer"

ezconfig.sh /etc/hosts autoset 127.0.0.1 "$(hostname)"

```



Output:

```

> Matches before the processing:

9:127.0.0.1 localhost

19:127.0.0.1     OldServer

> Matches after the processing:

9:127.0.0.1 localhost

19:127.0.0.1 NewServer

```

Since here we have two key/value sets with identical keys ("127.0.0.1"), you need to confirm whether it's okay to update the second instance (since we used `autoset`, that was confirmed automatically).



In case you need to *add* `127.0.0.1 NewServer` instead of *setting* the last instance of `127.0.0.1` to `NewServer`, use the `add` operation. It adds the key/value set if that set doesn't already exist. `add` operation does not require any confirmation.

```

hostnamectl set-hostname "NewServer"

ezconfig.sh /etc/hosts add 127.0.0.1 "$(hostname)"

```

Output:

```

> Matches before the processing:

9:127.0.0.1 localhost

19:127.0.0.1     OldServer

> Matches after the processing:

9:127.0.0.1 localhost

19:127.0.0.1     OldServer

20:127.0.0.1 NewServer

```

If we wanted to edit the spacing of our preexisting set at line 9 (`127.0.0.1 localhost`) we could run the following command:

```

ezconfig.sh /etc/hosts add 127.0.0.1 '     ' localhost

```

Output:

```

> Matches before the processing:

9:127.0.0.1 localhost

19:127.0.0.1     OldServer

> Matches after the processing:

9:127.0.0.1     localhost

19:127.0.0.1     OldServer

```



## Notes

- This script is not an appropriate tool for modifying files that can contain multiple key/value sets with identical keys.

- Has only been tested on Ubuntu 20.04.

- If you are specifying the connector, make sure to put space around it (`key=val` is INCORRECT. Should be ` key = val`)

- When using `reset` or `autoreset` be aware that this script does not distinguish between a **comment** and a **commented out key/value set**. So, if you try `ezconfig.sh file reset mykey myvalue`, a comment like `#mykey is a key of mine` is as likely to be affected as `#mykey 123`.