Integrate consoles, shells, and terminals inside Obsidian.
Integrate consoles, shells, and terminals inside Obsidian.
Repository · Changelog · Community plugin · Other things · Features · Installation · Usage · Contributing · Security
For first time users, read the installation section first!
This file is automatically opened on first install. You can reopen it in settings or command palette.
terminal
under .obsidian/plugins
of your vault.manifest.json
, main.js
, and styles.css
from the latest release into the directory.npm install
in the root directory.npm run obsidian:install <vault directory>
in the root directory.pip3 install psutil==5.9.5 pywinctl==0.0.50 typing_extensions==4.7.1
.
Open terminal
ribbon.
2. Choose the desired profile.Ctrl
+P
or click on the Open command palette
ribbon next to the left window border.
2. Choose the desired action (and profile).More options
Terminal tab is focused
Ctrl
+Shift
+`
Terminal is focused
Ctrl
+Shift
+`
Ctrl
+Shift
+K
, Command
+K
(macOS)Ctrl
+Shift
+F
, Command
+F
(macOS)This plugin comes with several profile presets that you can reference.
When setting up a terminal profile, you need to distinguish between shells and terminal emulators. (Search online if needed.) Generally, integrated profiles only work with shells while external ones only work with terminal emulators.
Shells
bash
sh
cmd
dash
<Git installation>\bin\bash.exe
(e.g. C:\Program Files\Git\bin\bash.exe
)pwsh
powershell
wsl
or wsl -d <distribution name>
zsh
Terminal emulators
cmd
gnome-terminal
konsole
/System/Applications/Utilities/Terminal.app/Contents/macOS/Terminal "$PWD"
wt
/Applications/iTerm.app/Contents/MacOS/iTerm2 "$PWD"
xterm
This plugin patches require
so that require("obsidian")
and other Obsidian modules work in the developer console. It is toggleable as Expose internal modules
in settings.
In the developer console, a context variable $$
is passed into the code, which can be used to dynamically change terminal options.
The full API is available from sources/@types/obsidian-terminal.ts
.
Ctrl
+Shift
+`
, then you can use Obsidian hotkeys again.Contributions are welcome!
This project uses changesets
to manage the changelog. When creating a pull request, please add a changeset describing the changes. Add multiple changesets if your pull request changes several things. End each changeset with ([PR number](PR link) by [author username](author link))
. For example, the newly created file under the directory .changeset
should look like:
---
"example": patch
---
This is an example change. ([GH#1](https://github.com/ghost/example/pull/1) by [@ghost](https://github.com/ghost))
The todos here, ordered alphabetically, are things planned for the plugin. There are no guarantees that they will be completed. However, we are likely to accept contributions for them.
Open terminal: Select
.Open terminal: Select
when a modifier key is pressed.Translation files are under assets/locales/
. Each locale has its own directory named with its corresponding IETF language tag. Some translation keys are missing here and instead located at obsidian-plugin-library
.
To contribute translation for an existing locale, modify the files in the corresponding directory.
For a new locale, create a new directory named with its language tag and copy assets/locales/en/translation.json
into it. Then, add an entry to assets/locales/en/language.json
in this format:
{
// ...
"en": "English",
"(your-language-tag)": "(Native name of your language)",
"uwu": "Uwuish",
// ...
}
Sort the list of languages by the alphabetical order of their language tags. Then modify the files in the new directory. There will be errors in assets/locales.ts
, which you can ignore and we will fix them for you. You are welcome to fix them yourself if you know TypeScript.
When translating, keep in mind the following things:
{{
and }}
({{example}}
). They are interpolations and will be replaced by localized strings at runtime.$t(
and )
($t(example)
). They refer to other localized strings. To find the localized string being referred to, follow the path of the key, which is separated by dots (.
). For example, the key youtu.be./dQw4w9WgXcQ
refers to:{
// ...
"youtu": {
// ...
"be": {
// ...
"/dQw4w9WgXcQ": "I am 'youtu.be./dQw4w9WgXcQ'!",
// ...
},
// ...
},
// ...
}
generic
are vocabularies. They can be referred in translation strings by $t(generic.key)
. Refer to them as much as possible to standardize translations for vocabularies that appear in different places.We hope that there will never be any security vulnerabilities, but unfortunately it does happen. Please report them!
Version | Supported |
---|---|
latest | ✅ |
outdated | ❌ |
Please report a vulerability by opening an new issue. We will get back to you as soon as possible.