sstallion_obsidian-command-.../README.md
2025-03-11 15:03:19 -05:00

2.6 KiB

Obsidian Command Line

This plugin adds enhanced support for command line code blocks in Obsidian.

Features

  • Copy command lines from your notes without selecting text.
  • Prompts and output are removed from clipboard contents to support pasting into terminal sessions.
  • Default prompts are provided for command lines that do not specify one.
  • Optional syntax highlighting and styling using Prism Command Line.
  • Optional support for removing unnecessary white space from clipboard contents.
  • Supports mobile and desktop.

Getting Started

Command line code blocks are identified using one of the following languages:

Name Highlight Prompt Pattern Default Prompt Continuation
powershell-command powershell /\S*?>/ PS> `
shell-command shell /\S*?[#$%]/ $ \
windows-command batch /\S*?>/ C:\> ^

For example, copying the following code block to the clipboard will remove the prompt and output while preserving line continuations and white space:

```shell-command
$ command with \
    line continuation
and output, which will be removed
from the clipboard.
```

Note

If clipboard normalization is enabled in Settings, unnecessary white space (including line continuations) will be removed in addition to the prompt and output.

Contributing

Pull requests are welcome! See CONTRIBUTING.md for details.

License

Source code in this repository is licensed under a Simplified BSD License. See LICENSE for details.