Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cpdt/slinky
Run Bash commands from Windows Command Prompt, natively!
https://github.com/cpdt/slinky
bash windows-subsystem-linux wsl
Last synced: about 1 month ago
JSON representation
Run Bash commands from Windows Command Prompt, natively!
- Host: GitHub
- URL: https://github.com/cpdt/slinky
- Owner: cpdt
- License: mit
- Archived: true
- Created: 2016-04-12T08:23:04.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2017-04-13T18:11:07.000Z (over 7 years ago)
- Last Synced: 2024-06-11T13:45:08.543Z (3 months ago)
- Topics: bash, windows-subsystem-linux, wsl
- Language: Shell
- Size: 49.8 KB
- Stars: 18
- Watchers: 2
- Forks: 2
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- jimsghstars - cpdt/slinky - Run Bash commands from Windows Command Prompt, natively! (Shell)
README
# Slinky
> **Super Link, Yo** - Run native Linux commands from your Windows shell!
Slinky allows you to run Linux commands in the Windows shell - instead of having to open up a Bash Windows implementation whenever you need to bash out some scripts, Slinky lets you run those commands straight from your Windows (or Powershell) command prompt.
**Slinky requires an implementation of `bash` to be installed on your computer.** If you're running the Windows 10 Aniversary update or later, you can [use the in-built Ubuntu for Windows bash](http://www.howtogeek.com/249966/how-to-install-and-use-the-linux-bash-shell-on-windows-10/). Otherwise, install an alternate tool such as [Git Bash](https://git-for-windows.github.io/)/[MSYS Bash](http://www.mingw.org/wiki/msys) or [Cygwin](https://www.cygwin.com/).
## Install
To install Slinky, run the following command in your Bash environment.
```
bash <(curl https://raw.githubusercontent.com/cpdt/slinky/master/install.sh)
```
## Usage
In your Bash or Windows shell, run the command below to link a command in the Windows prompt to a Bash command (i.e running the command in the Windows prompt will actually run the Bash command).
```bash
$ slink [command name]
```
Alternatively, you can assign a different name to the Windows command by providing two parameters:
```bash
$ slink [windows command] [linux command]
```
> **Example 1:**
> Link the `curl` command so it is runnable from Windows:
> ```bash
> C:\> slink curl
> C:\> curl ...etc...
> ```
> **Example 2:**
> Link Linux's `echo` command so it is runnable as `do-echo` from Windows:
> ```bash
> C:\> slink do-echo echo
> C:\> do-echo ...etc...
> ```
#### Delete a link
You can delete a link with the `rmslink` command.
```bash
$ rmslink [windows command]
```
> **Example 1:**
> Remove a link for the `curl` command:
> ```bash
> C:\> rmslink curl
> ```
> **Example 2:**
> Remove a link between Linux's `echo` command and the `do-echo` command on Windows:
> ```bash
> C:\> rmslink do-echo
> ```
#### List all links
You can view a list of the Windows command names of all commands with the `lsslink` command.
```bash
$ lsslink
```
#### Uninstall Slinky
Tired of being awesome and want to go back to being a regular command-prompt user? The `delslink` command is for you! This command will, as the name suggests, delete Slinky and all related files from your computer. **Slinky links will not be kept around, so if you uninstall Slinky and then re-install, you will need to re-create all of your links.**
```bash
$ delslink
```
## FAQ
**Can I create/remove/list Slinky links from the Bash shell?**
Yes - the Slinky commands are actually Bash script files, installed by default in `/usr/local/bin`. As a result, these commands will be available in the Bash shell as long as this installation directory is in your PATH.
**Why does the GIF show vim being opened? Is slinky only for vim users?**
Now you're just reading too far into the GIF :wink:. Vim is being used simply to demonstrate what Slinky does, but this doesn't mean you can't run `slink emacs` or `slink nano` or even `slink ed` and enjoy your favourite terminal editor on Windows.
## License
Slinky is licensed under the MIT license, included in the `LICENSE` file.