Skip to content

Commit

Permalink
Merge branch 'dev' of github.com:oliverschwendener/ueli into dev
Browse files Browse the repository at this point in the history
  • Loading branch information
oliverschwendener committed May 29, 2018
2 parents ebd0e73 + b3b19cf commit cfd2408
Show file tree
Hide file tree
Showing 4 changed files with 40 additions and 38 deletions.
69 changes: 31 additions & 38 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,26 +37,26 @@ This is a keystroke launcher for Windows and macOS.

### Program search

![Feature Program search](img/doc/features/ueli-feature-program-search.png)

* You can search for installed programs
* Use the arrow keys to scroll up and down
* Presss Enter to launch the selected program

### Files and folder search
![Feature Program search](img/doc/features/ueli-feature-program-search.png)

![Feature home folder](img/doc/features/ueli-feature-home-folder.png)
### Files and folder search

* You can search files and folders in your home folder
* Press Enter to open the selected file/folder

### Open URLs with your default web browser
![Feature home folder](img/doc/features/ueli-feature-home-folder.png)

![Feature URL](img/doc/features/ueli-feature-url.png)
### Open URLs with your default web browser

* Type in a URL
* Press enter to open the URL with your default web browser

![Feature URL](img/doc/features/ueli-feature-url.png)

### Open default mail program

* Type in a email address
Expand All @@ -66,22 +66,10 @@ This is a keystroke launcher for Windows and macOS.

### Web search engines

![Feature web search engines](img/doc/features/ueli-feature-web-search.png)
* You can use web search engines with a prefix and `?`.
* Example: `g?{your search term}`

* You can [customize](#customization) web search engines like this:

``` json
"webSearches": [
{
"icon": "<svg>...</svg>",
"name": "Google",
"prefix": "g",
"url": "https://google.com/search?q="
}
]
```

Now you can type in `g?{your search term}` to launch the web search engine in your default browser.
![Feature web search engines](img/doc/features/ueli-feature-web-search.png)

Default web search engines:

Expand All @@ -94,38 +82,49 @@ Default web search engines:
|`w`|[Wikipedia](https://wikipedia.org)|
|`yt`|[YouTube](https://youtube.com)|

### Execute commandline tools
* You can [customize](#customization) web search engines like this:

![Feature commandline](img/doc/features/ueli-feature-commandline.png)
``` json
"webSearches": [
{
"icon": "<svg>...</svg>",
"name": "My Search Engine",
"prefix": "m",
"url": "https://my-search-engine.com/search?q="
}
]
```

### Execute commandline tools

* Start a commandline tool with the `>` prefix
* Example: `>ipconfig /all`
* Stop an executing commandline tool with `Ctrl+c`

> Note: you can **not** interact with the commandline tool. You only see the output.
### Browse file system
![Feature commandline](img/doc/features/ueli-feature-commandline.png)

![Feature file browser](img/doc/features/ueli-feature-file-browser.png)
### Browse file system

* You can browse your file system by typing in a filepath
* Example: `C:\Users` or `/Applications`
* Press `Enter` to open the file or folder
* Press `Tab` for autocompletion

### Calculator
![Feature file browser](img/doc/features/ueli-feature-file-browser.png)

![Feature calculator](img/doc/features/ueli-feature-calculator.png)
### Calculator

* Calculate simple math, matrix, symbolic function, convert unit and a lot more.
* Example:
* `23 * 24 / 2 + (6 * 7) ^ 2`
* `1 km/h to mile/h`
* `a = [1, 2, 3]; a * 2`

### Custom commands
![Feature calculator](img/doc/features/ueli-feature-calculator.png)

![Feature custom commands](img/doc/features/ueli-feature-custom-commands.png)
### Custom commands

* You can [customize](#customization) custom commands to
* Start command line tools
Expand All @@ -138,18 +137,12 @@ Default web search engines:
"name": "ping",
"executionArgument": "start ping 8.8.8.8 -t",
"icon": "<svg>...</svg>"
},
{
"name": "Data",
"executionArgument": "start \"\" \"C:\\Data\""
},
{
"name": "code",
"executionArgument": "start \"\" \"C:\\My-Programs\\Visual Studio Code\\Visual Studio Code.lnk\""
},
}
]
```

![Feature custom commands](img/doc/features/ueli-feature-custom-commands.png)

### Keyboard shortcuts

|Keyboard shortcut|Description|
Expand Down
1 change: 1 addition & 0 deletions src/ts/ipc-channels.ts
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ export class IpcChannels {
public static readonly commandLineOutput = "command-line-output";
public static readonly ueliReload = `${UeliHelpers.ueliCommandPrefix}reload`;
public static readonly ueliExit = `${UeliHelpers.ueliCommandPrefix}exit`;
public static readonly ueliCheckForUpdates = `${UeliHelpers.ueliCommandPrefix}check-for-updates`;
public static readonly exitCommandLineTool = "exit-command-line-tool";
public static readonly resetCommandlineOutput = "reset-commandline-output";
public static readonly resetUserInput = "reset-user-input";
Expand Down
4 changes: 4 additions & 0 deletions src/ts/main.ts
Original file line number Diff line number Diff line change
Expand Up @@ -265,3 +265,7 @@ ipcMain.on(IpcChannels.resetUserInput, (): void => {
ipcMain.on(IpcChannels.showHelp, (): void => {
new WebUrlExecutor().execute("https://github.com/oliverschwendener/ueli#ueli");
});

ipcMain.on(IpcChannels.ueliCheckForUpdates, (): void => {
autoUpdater.checkForUpdates();
});
4 changes: 4 additions & 0 deletions src/ts/search-plugins/ueli-commands-plugin.ts
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,10 @@ export class UeliCommandsSearchPlugin implements SearchPlugin {
executionArgument: UeliHelpers.configFilePath,
name: "Edit configuration file",
} as UeliCommand,
{
executionArgument: IpcChannels.ueliCheckForUpdates,
name: "Check for updates",
},
];
}

Expand Down

0 comments on commit cfd2408

Please sign in to comment.