Skip to content

Commit

Permalink
Added PackageControl to readme and changed config file
Browse files Browse the repository at this point in the history
  • Loading branch information
bantya committed Mar 20, 2019
1 parent 18cd0a7 commit b2d1e37
Show file tree
Hide file tree
Showing 2 changed files with 40 additions and 25 deletions.
63 changes: 39 additions & 24 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,85 +3,98 @@
This is Command, a plugin for the
[Keypirinha](http://keypirinha.com) launcher.

This package provides an easy way to execute simple commands from launcher.
This plugin provides an easy way to execute simple commands from Keypirinha.

![Command usage](./images/demo.gif "Command usage")
| ![Command usage](./images/demo.gif "Command usage") |
| :-: |
| *Command demo* |

## Install

There are two ways to install:

1. Using **PackageControl**:
1. Using **[PackageControl](https://github.com/ueffel/Keypirinha-PackageControl)**:

- Invoke Keypirinha and type `install package`.
- Click enter.
- Now search for package `Command`.
- Now search for package `Keypirinha-Command`.
- Again press enter.

About [PackageContol](https://github.com/ueffel/Keypirinha-PackageControl).

2. Manual:

Download the plugin file from [here](https://github.com/bantya/Keypirinha-Command/releases).
Download the latest plugin file from [here](https://github.com/bantya/Keypirinha-Command/releases/latest).

Once the `Command.keypirinha-package` file is downloaded,
move it to the `InstalledPackage` folder located at:

* `Keypirinha\portable\Profile\InstalledPackages` in **Portable mode**
* **Or** `%APPDATA%\Keypirinha\InstalledPackages` in **Installed mode** (the
- `Keypirinha\portable\Profile\InstalledPackages` in **Portable mode**
- **Or** `%APPDATA%\Keypirinha\InstalledPackages` in **Installed mode** (the
final path would look like
`C:\Users\%USERNAME%\AppData\Roaming\Keypirinha\InstalledPackages`)

**NOTE:** You may have to manually restart Keypirinha to see the package activated.




## Configuration

0. There is no configuration required. If you want, you can proceed to **Step 1**.

1. Open the `Command` config file.

![Command config](./images/config.png "Command config")
| ![Command config](./images/config.png "Command config") |
| :-: |
| *Command configuration menu* |

2. Set `close_cmd`.
2. Set `close_cmd` in `main` section.

![Command files](./images/files.png "Command files")
| ![Command files](./images/files.png "Command files") |
| :-: |
| *Command configuration files* |

The possible values are:

- `yes`: Close the command prompt after executing the command.
- `yes`: Close the command prompt after executing the command.
- `no`: Keep the command prompt open. (Default)

## Usage

![Command usage](./images/usage.png "Command usage")
## Usage

Invoke Keypirinha and put the command to be executed in following format:
```
> [command (can contain spaces)]
[> sign] [command (can contain spaces)]
e.g.
> ping google.com -> This will open the command prompt and ping google.com
```

| ![Command usage](./images/usage.png "Command usage") |
| :-: |
| *Command usage* |

### Actions

There are two actions available irrespective of the configuration.

![Command actions](./images/actions.png "Command actions")
| ![Command actions](./images/actions.png "Command actions") |
| :-: |
| *Command actions* |

- **Keep Open**: Do not close the prompt after running the command.
- **Keep Open**: Do not close the prompt after running the command.
- **Close CMD**: Close the prompt after running the command.


## Change Log

### v1.0
### v1.0.1

- Added PackageControl section in README.
- Updated config file.

### v1.0.0

* Initial release.
* Added actions.
- Initial release.
- Added actions.


## License
Expand All @@ -95,7 +108,9 @@ MIT, that's it.


## Contribute

Here is how to contribute:

1. Check for open issues or open a fresh issue to start a discussion around a
feature idea or a bug.
2. Fork this repository on GitHub to start making your changes to the **dev**
Expand Down
2 changes: 1 addition & 1 deletion src/command.ini
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
#
# * close_cmd
# Close the command prompt after executing a command.
# dafault = no
# Default = no

[var]
# As in every Keypirinha's configuration file, you may optionally include a
Expand Down

0 comments on commit b2d1e37

Please sign in to comment.