https://github.com/happycod3r/zsh-toggles
Allows you to toggle the value of a variable in a file
https://github.com/happycod3r/zsh-toggles
file-parsing parsing shell shell-script terminal v1 zsh zsh-toggle zshell zshrc
Last synced: 4 months ago
JSON representation
Allows you to toggle the value of a variable in a file
- Host: GitHub
- URL: https://github.com/happycod3r/zsh-toggles
- Owner: happycod3r
- License: mit
- Created: 2023-06-30T23:38:41.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-07-04T18:13:24.000Z (almost 3 years ago)
- Last Synced: 2025-06-16T08:06:23.879Z (12 months ago)
- Topics: file-parsing, parsing, shell, shell-script, terminal, v1, zsh, zsh-toggle, zshell, zshrc
- Language: Shell
- Homepage:
- Size: 2.09 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Zsh Toggles v1.1.0
## [Table Of Contents](#table_of_contents)
- [About](#about)
- [Install](#install)
- [Manual Install](#manual_install)
- [Command Line Install](#command_line_install)
- [Using Curl](#using_curl)
- [Using Git Clone](#git_clone)
- [Usage](#usage)
- [Contributing](#contributing)
- [Security](#security)
- [Contacts](#contacts)
---
## [About](#about)
Zsh-Toggle is a function that will allow you to toggle the value of a variable in a file.
If you want to let a user turn an option on or off in your program you can do it easily with Zsh-Toggle.
---
## [Install](#install)
To download and install zsh-toggles follow choose an install method and follow the corresponding steps. Once
fininshed jump to the [Usage](#usage) section.
### [Manual Install](#manual_install)
1. Download and place the ***zsh-toggles*** folder in a location of your choosing.
2. Next source the script as shown in the [Usage](#usage) section.
### [Command Line Install](#command_line_install)
#### [Using Git Clone:](#git_clone)
1) Open your terminal and navigate to the directory where you want to clone the repository:
```bash
cd where/I/want/to/install
```
2) Next run the following command to clone the repository to the chosen location:
```bash
git clone https://github.com/happycod3r/zsh-toggles.git
```
#### [Using Curl:](#curl)
1) Pick a directory to download it to:
```bash
cd where/I/want/
```
2) Paste the following line into your terminal and press the `Enter (^M)` key:
```bash
curl https://github.com/happycod3r/zsh-toggles.git
```
---
## [Usage](#usage)
### Parmeters for zsh-toggle()
- arg1: `EXPORT`
- [true|false]
- Whether the variable has an `export` statement or not. Default is ***'false'***
- arg2: `DQUOTES`
- [true|false|none]
- Whether the variable has double quotes, single quotes or none. Default is ***'true'***
- arg3: `VAR_NAME`
- [string]
- The name of the variable
- arg4: `VALUE`
- [string]
- The current value of the variable
- arg5: `ALT_VALUE`
- [string]
- The alternte value for the variable
- arg6: `FILE_PATH`
- [string]
- The fully qualified path to the file containing the variable
In the file that contains the variable(s) that you want to toggle.
The variable should ...
- be on a line of its own.
- be only one of the following formats:
- `$MY_VAR="true"` no export statement, double quotes
- `$MY_VAR='true'` no export statement, single quotes.
- `$MY_VAR=true` no export statement, no quotes.
- `export $MY_VAR="true"` export statement, double quotes
- `export $MY_VAR='false'` export statement, single quotes.
- `export $MY_VAR=false` export statement, no quotes.
- be initialized with a value such as true|false, on|off, 1|0, yes|no John|Amy etc.
- It can be any two values that you want to toggle between.
The variable you are toggling should be initialized in its
file already with either VALUE or ALT_VALUE otherwise it won't work.
For example if you set
```bash
VALUE="yes"
ALT_VALUE="no"
```
then in the file @ `FILE_PATH` the variable should be initialized
with either **"yes"** or **"no"**. ex. `MY_VAR="yes"` or `MY_VAR="no"`
The same with the other options too. If you set `DQUOTES` or `EXPORT` to
**"true"** then the variable value should be wrapped in double quotes
and/or be exported already in the file. Your basically describing the
variable with these options
### Another example:
If you call `zsh-toggle` like this
```bash
zsh-toggle false true TEST "false" "true" "$(pwd)/test.conf"
```
then the variable in the file your pointing at with the last argument should look like this:
```bash
TEST="false"
# or
TEST="true"
```
If you call `zsh-toggle` like this
```bash
zsh-toggle true false TEST "on" "off" "$(pwd)/test.conf"
```
then the variable in the file your pointing at with the last argument should look like this:
```bash
export TEST='on'
# or
export TEST='off'
```
You can also call `zsh-toggle` passing `"none"` for the 2nd argument to use no quotes like this:
```bash
zsh-toggle false none TEST "false" "true" "$(pwd)/test.conf"
```
In this case the variable in the file your pointing at with the last argument should look like this:
```bash
TEST=false
# or
TEST=true
```
---
## [Contributing](#contributing)
If you have any feature requests, suggestions or general questions you can reach me via any of the methods listed below in the [Contacts](#contacts) section.
---
## [Security](#security)
### Reporting a vulnerability or bug?
**Do not submit an issue or pull request**: A general rule of thumb is to never publicly report bugs or vulnerabilities because you might inadvertently reveal it to unethical people who may use it for bad. Instead, you can email me directly at: [paulmccarthy676@gmail.com](mailto:paulmccarthy676@gmail.com). I will deal with the issue privately and submit a patch as soon as possible.
---
## [Contacts](#contacts)
**Author:** Paul M.
* Email: [paulmccarthy676@gmail.com](mailto:paulmccarthy676@gmail.com)
* Github: [https://github.com/happycod3r](https://github.com/happycod3r)
* Linkedin: [https://www.linkedin.com/in/paul-mccarthy-89165a269/]( https://www.linkedin.com/in/paul-mccarthy-89165a269/)
* Facebook: [https://www.facebook.com/paulebeatz]( https://www.facebook.com/paulebeatz)
---