mirror of
https://github.com/Stone-Red-Code/ClipCMD.git
synced 2026-09-09 23:39:00 +02:00
Standardize README
This commit is contained in:
@@ -1,56 +1,45 @@
|
|||||||
# ClipCMD
|

|
||||||
|
|
||||||
> A simple utility program to simplify your workflow
|
> A simple utility program to simplify your workflow by executing scripts through the clipboard.
|
||||||
|
|
||||||
## What is it?
|
## What is it?
|
||||||
|
|
||||||
ClipCMD is a Windows app that allows you to create macros and run them by copying them to the clipboard.\
|
ClipCMD is an app that allows you to create commands and run them by copying them to the clipboard.\
|
||||||
You write a macro anywhere, copy it to your clipboard, and it will be automatically replaced by the output of the specified macro script.\
|
You can write a command anywhere, copy it to your clipboard, and it will be automatically replaced by the output of the specified command script.\
|
||||||
ClipCMD uses [PowerShell](https://learn.microsoft.com/en-us/powershell/scripting) as scripting language.
|
ClipCMD uses [PowerShell](https://learn.microsoft.com/en-us/powershell/scripting) as the scripting language.
|
||||||
|
|
||||||
### Example
|
## Usage
|
||||||
|
|
||||||
|
1. Download & install the latest release
|
||||||
|
- Microsoft Store: [Store Page](https://www.microsoft.com/store/productId/9NZ7PCLGPBW5)
|
||||||
|
- GitHub: [Releases](https://github.com/Stone-Red-Code/ClipCMD/releases)
|
||||||
|
1. (Optional) Put a shortcut to the `ClipCMD.Desktop.exe` file in the installation directory into the `shell:startup` directory.
|
||||||
|
1. Start the app and add a new command.
|
||||||
|
1. Press the script button to edit the command script.
|
||||||
|
1. Open an editor and type `<prefix><commandName><suffix>`.
|
||||||
|
1. Copy the command to the clipboard.
|
||||||
|
1. Whatever the script outputs should now be pasted into the editor.
|
||||||
|
|
||||||
|
## Follow the development
|
||||||
|
|
||||||
|
[](https://x.com/search?q=from%3A%40StoneRedCode%20%23ClipCMD)
|
||||||
|
|
||||||
|
## Example
|
||||||
|
|
||||||
> Prefix: `_`\
|
> Prefix: `_`\
|
||||||
> Suffix: `_`\
|
> Suffix: `_`\
|
||||||
> Macro name: `email`\
|
> Command name: `email`\
|
||||||
> Macro script: `Write-Output [email protected]`\
|
> Command script: `Write-Output [email protected]`\
|
||||||
> Macro script (alternative): `"[email protected]"`
|
> Command script (alternative): `"[email protected]"`\
|
||||||
|
|
||||||
> Input: `_email_`\
|
> Input: `_email_`\
|
||||||
> Output: `[email protected]`
|
> Output: `[email protected]`
|
||||||
|
|
||||||
## Usage
|
|
||||||
|
|
||||||
1. Download one of the [releases](https://github.com/Stone-Red-Code/ClipCMD/releases) directly from GitHub or download it with [HyperbolicDownloader](https://github.com/Stone-Red-Code/HyperbolicDownloader)
|
|
||||||
1. Start `setup.exe`
|
|
||||||
1. (Optional) Set the prefix and suffix for your commands
|
|
||||||
1. Specify some commands in the built-in text field
|
|
||||||
- Format:
|
|
||||||
```
|
|
||||||
[<command name(s) (separated by comma)>]
|
|
||||||
<scriptText>
|
|
||||||
<scriptText>
|
|
||||||
<scriptText>
|
|
||||||
...
|
|
||||||
[<command name(s) (separated by comma)>]
|
|
||||||
<scriptText>
|
|
||||||
<scriptText>
|
|
||||||
<scriptText>
|
|
||||||
...
|
|
||||||
```
|
|
||||||
- Strings between square brackets define macros.
|
|
||||||
- You can define macro aliases by separating them by a comma `[quit, exit, q]`
|
|
||||||
- Lines between a macro definition and the next macro (or the end of the file) is PowerShell code.
|
|
||||||
- Everything you write to the output stream replaces the input macro.
|
|
||||||
- You can pass parameters to the scripts by separating the parameters by space after the macro: `_combine hi nope_`
|
|
||||||
- You can access the parameters by accessing the `$args` array.
|
|
||||||
1. There is one prebuilt macro named `list`. This lists all of your macros.
|
|
||||||
1. Write `[suffix][macroName][preffix]` somewhere, and then select it and press `CTRL+C`
|
|
||||||
|
|
||||||
## Preview
|
## Preview
|
||||||
|
|
||||||
<img width="591" alt="image" src="https://user-images.githubusercontent.com/56473591/226146460-d9d2e8fc-3754-44c7-bc43-2e32f1d07847.png">
|
|
||||||
|
|
||||||
## Third party licences
|
## Third party licences
|
||||||
- [InputSimulator](https://github.com/michaelnoonan/inputsimulator) - [MIT](https://github.com/michaelnoonan/inputsimulator/blob/master/LICENSE)
|
|
||||||
|
|
||||||
|
- [Avalonia](https://github.com/AvaloniaUI/Avalonia) - [MIT](https://github.com/AvaloniaUI/Avalonia/blob/master/licence.md)
|
||||||
|
- [Icons.Avalonia](https://github.com/Projektanker/Icons.Avalonia) - [MIT](https://github.com/Projektanker/Icons.Avalonia/blob/main/LICENSE)
|
||||||
|
- [Semi.Avalonia](https://github.com/irihitech/Semi.Avalonia) - [MIT](https://github.com/irihitech/Semi.Avalonia/blob/main/LICENSE)
|
||||||
|
- [SharpHook](https://github.com/TolikPylypchuk/SharpHook) - [MIT](https://github.com/TolikPylypchuk/SharpHook/blob/main/LICENSE)
|
||||||
|
|||||||
Reference in New Issue
Block a user