The skimmark command

The skimmark command opens Markdown files in Skimmark from a terminal. It is available on Mac, Windows, and Linux.

Install it

1. Open the menu:
   • Mac: the Skimmark app menu.
   • Windows and Linux: the Help menu.
2. Choose Install 'skimmark' Command…
3. Mac and Linux: if your computer asks for an admin password, enter it. Skimmark asks only when the install folder needs it. Windows never asks.

A bar at the top of the window says Installed skimmark at <path>.

On Windows, the first install also adds the install folder to your user PATH, and the bar says Installed skimmark. Open a new terminal to use it. Terminals that were already open do not see the change; open a new PowerShell or Command Prompt window.

Where it goes:

• Mac: /usr/local/bin/skimmark
• Linux: ~/.local/bin/skimmark if ~/.local/bin is on your PATH, otherwise /usr/local/bin/skimmark
• Windows: %LOCALAPPDATA%\Programs\Skimmark\bin\skimmark.cmd

On Mac and Linux, Skimmark never edits your shell settings or your PATH. On Windows it adds only its own bin folder to your user PATH, once, and only if the folder is not there yet. It never needs admin rights and never changes the system PATH.

Use it

The command returns right away, so your terminal is free while Skimmark stays open.

On Windows, the same file typed with different capital letters (Notes.md, NOTES.md) is one file, so it opens in the same tab.

If something goes wrong

• Could not install skimmark: <path> already exists and was not installed by this app. Another program already uses that name. Skimmark leaves it alone. Remove or rename that file yourself if you want Skimmark's command there.
• skimmark: app not found at <path>; reinstall the skimmark command You moved or deleted Skimmark after installing the command. Open Skimmark from its new place and install the command again.
• Could not install skimmark (<code>): <reason> The install did not finish, for example because the password prompt was cancelled. Try again.
• Windows, Could not install skimmark (path-update-failed): ... The command was installed, but Skimmark could not add its folder to your user PATH. Try again, or add the folder named in the message to your user PATH yourself.
• Windows, 'skimmark' is not recognized in a terminal: the terminal was opened before the install. Open a new one.
• Windows, Could not install skimmark (path-too-long): ... Adding the folder would make your PATH longer than Windows terminals accept (8191 characters). The command file is installed; remove PATH entries you no longer use, then install again.
• Windows, a file name with &, |, < or > in it: put the name in quotes (skimmark "Doe & Co.md"). Without quotes, the terminal treats those characters as commands.

The old mdr command

Earlier test builds named this command mdr (Mac and Linux only; Windows never had it). When Skimmark starts on Mac or Linux, it looks for an old mdr that it installed itself and that opens this copy of Skimmark. It checks /usr/local/bin and ~/.local/bin.

• If Skimmark can delete it, it does, and the bar at the top of the window says Removed the old mdr command at <path>. Use skimmark instead.
• If the folder needs an admin password (often the case for /usr/local/bin), Skimmark does not ask for one. The bar says An old mdr command is at <path>. You can delete it. You normally see this message only once. It can show again if Skimmark cannot save to its settings folder.

Skimmark never touches or mentions an mdr that some other program installed, a shortcut (symlink) named mdr, or an mdr that opens a different or moved copy of Skimmark. If you have not installed skimmark yet, choose Install 'skimmark' Command… first (see above), then change any scripts or aliases that call mdr to skimmark.