Support

Contact

Email contact@gramshift.com in English or Japanese. We reply within 7 business days, usually sooner. Please include your Windows version, your Stream Deck app version, the command and the "Run with" choice (remove anything secret), and, if possible, a photo or screenshot of the key and of its settings. Please do not send passwords, keys or other secrets.

Run Command

1. Install the plugin from the Elgato Marketplace. In the Stream Deck app, find Command Status for Windows in the action list and drag Run Command onto a key.
2. Select the key and enter the Command, for example npm test, and the Folder it runs in, for example C:\Users\you\source\app. Tip: in File Explorer, select a folder and press Ctrl+Shift+C ("Copy as path"), then paste it. Quotes are removed, and %USERPROFILE% style variables and a leading ~ work. An empty folder means your user folder. A network folder (\\server\share) can not be used with Command Prompt, because cmd.exe does not run in such a folder (it would run in C:\Windows instead); the key then shows ERROR. Use Windows PowerShell or a mapped drive letter.
3. Choose Run with: Command Prompt (cmd) (default; the command runs as cmd.exe /d /s /c "<command>", so &, > and .bat / .cmd files work as in a Command Prompt), Windows PowerShell (powershell.exe -NoProfile -NonInteractive; when the last statement of your command fails, the exit code is that of the last program it ran, or 1 for a PowerShell error, so success codes such as 0-7 for robocopy work here too), or Program (no shell) (the first word, or a quoted path, is the program; the rest of the line is passed to it unchanged).
4. Press the key. While it runs the key has a blue frame and shows the time so far. Press again to stop the command and every program it started.
5. When it ends: a green frame and OK when the exit code is a success code; a red key and FAILED when it is not. The key also shows the exit code, the time taken and the last line of output. The Result line in the key's settings shows the same and the last lines of output.

Watch Command

1. Drag Watch Command onto a key and set it up like Run Command, plus Every (1, 5, 15, 30 or 60 minutes; default 5).
2. Press the key once. It runs the command at once and from then on at the chosen interval, while the key is visible. The key shows the latest result and the time it ran.
3. Nothing runs by itself before that first press, and again after you change the command, the "Run with" choice or the folder: the settings save every keystroke, and a half-typed command must not run by itself. Keys in a profile you import from someone else also wait for your press, unless you already started the same command, with the same "Run with" choice and folder, with a Watch Command key on this PC.
4. When the key is not visible (another page or profile), no new run starts. A run that is going finishes, and its result is shown when the key is visible again.

What the key shows

A red key also shows the Stream Deck warning triangle once. A Watch Command key that keeps failing shows it only when it turns from OK to failed, not at every run.

Common questions

A program that needs an exit code other than 0 for success.
Enter the Success codes: numbers and ranges separated by commas, for example 0-7 for robocopy or 0, 1. Parts that are not understood are ignored and named in the Result line.

The command asks a question and never ends.
Commands get no input, so a question gets no answer. Most programs then stop with an error; others wait until the time limit. Use the program's option to run without questions (for example --yes or /Y).

Japanese or other non-English output looks wrong.
The plugin reads each line as UTF-8 when it is valid UTF-8 and otherwise in your console code page (on Japanese Windows, Shift_JIS), and it reads UTF-16 output too. If a program writes in yet another encoding, its lines may look wrong; the exit code and the colors are not affected.

Very long output.
Only the last 64 KB are kept. The Result line then says so.

Programs started in the background by my command.
When a command ends by itself, programs it started to keep running (for example a server started with start) are left alone. When the plugin ends a command (at the time limit, when you press the key while it runs, and when the Stream Deck app closes), it ends the command and the programs running under it. A program whose starter has already exited (some launchers work that way) is no longer under the command and keeps running.

Deleting a key while its command runs.
The command keeps running until it ends or reaches its time limit. Press the key to stop it before you delete it.

Does it run as administrator?
The plugin never asks for administrator rights. Commands run with the same Windows account and permissions as the Stream Deck app (normally your user without administrator rights). A command that needs administrator rights then fails, or opens a Windows prompt, depending on the program.

Does it work on Mac?
No. This plugin is for Windows 10 or later only.

Privacy

The plugin runs entirely on your PC and sends no data anywhere. See the Privacy Policy.