https://github.com/blackphlox/wte

Windows Terminal Editor - Using rust to combine performance and the usefulness of wt-editor-cli & wt-editor-gui into one packaged executable.
https://github.com/blackphlox/wte

cli editor gui json-schema windows-subsystem-linux windows-terminal windows-terminal-configure

Last synced: about 1 month ago
JSON representation

Windows Terminal Editor - Using rust to combine performance and the usefulness of wt-editor-cli & wt-editor-gui into one packaged executable.

• Host: GitHub
• URL: https://github.com/blackphlox/wte
• Owner: BlackPhlox
• License: mit
• Created: 2020-05-09T11:23:39.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2020-07-28T09:21:25.000Z (over 4 years ago)
• Last Synced: 2024-12-17T00:13:59.972Z (about 2 months ago)
• Topics: cli, editor, gui, json-schema, windows-subsystem-linux, windows-terminal, windows-terminal-configure
• Language: Rust
• Homepage:
• Size: 76.2 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 11
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


WTE is an all-in-one realtime editor for updating of Windows Terminal settings. This gif is showing [wt-editor-cli](https://github.com/BlackPhlox/wt-editor-cli), a prototype of wte written in node.js. The goal is to create an .exe that can run either as a cli as shown and or host a local static serve and use [json-editor](https://github.com/json-editor/json-editor) to function as a [gui](https://github.com/BlackPhlox/wt-editor-gui).

![wt-editor-cli-showcase](https://user-images.githubusercontent.com/25123512/68077919-ba2a4980-fdcc-11e9-879f-6e1fecb6bb20.gif)

|Info| |

|-------|---------|

| GitHub | [![GitHub version](https://badge.fury.io/gh/BlackPhlox%2Fwte.svg)](https://badge.fury.io/gh/BlackPhlox%2Fwte) |

| Twitter     | [![Twitter Follow](https://img.shields.io/twitter/follow/darkphlox?style=social)](https://twitter.com/darkphlox)      |

## Related repositories

  - [wt-editor-cli](https://github.com/BlackPhlox/wt-editor-cli) - Real-time command-line editor for Windows Terminal settings

  - [wt-editor-gui](https://github.com/BlackPhlox/wt-editor-gui) - A graphical user interface version of wt-editor-cli

  - [nateshmbhat's windows-terminal-tweaker](https://github.com/nateshmbhat/windows-terminal-tweaker) - A electron-based windows terminal editor

# Prerequisites

  - Running Windows 1903 (build >= 10.0.18362.0) or later

  - Have installed Windows Terminal Version 1.0.1401.0 or later

  - Have installed Rust 1.44.0 or later

  

# Setup

Before doing anything I will highly recommend that you backup you settings.json prior to working with this project.

When running src/setup.bat

- Generates a config.json, which locates the folder of your settings.json (which is located here: ```%appdata%\..\Local\Packages\Microsoft.WindowsTerminal_8wekyb3d8bbwe\LocalState\```)

- Creates a backup of your current settings (called settings.json.pre.wte.backup in the same folder)

- Prompted to allow administrative rights to powershell, this is for setting a environment variable to the projects folder. As it is not setup yet, then you can easily decline and run the project using ```cargo run```. The environment variable can be found by running ```powershell -window minimized -command "SystemPropertiesAdvanced"``` and clicking on Environment variables > System Variables > Path > Scroll to the buttom.

- Creates a .batfile that calls ```cargo run``` when typing ```wte``` (Granted that the environment variable has been set)

## config.json

WTE uses config.json to know what settings.json-file to edit. To debug I would recommend copying your settings.json and changing the settings_folder_path for debug perpose shown below. Default is to your folder of your settings.json

```

{ 

    "settings_folder_path":"C:/Users/USERNAME/Repos/wte/src/", 

    "asset_path":"...", 

    "questionColor":"lightgray", 

    "errorColor":"red" 

} 

```

WIP

## Additionally step

  - If you are running using the [Linux-Subsystem](https://docs.microsoft.com/en-us/windows/wsl/install-win10) you can add `alias wte='cmd.exe /c wte'` in your `~/.bashrc` file.

# Contribution

Any contribution is appreciated, their are no formalities, just create a pull request.

### Creating Pull Requests

  Push your commit to get it back up to your fork: git push origin HEAD

  Visit Github, click handy “Pull request” button that it will make upon noticing your new branch.