https://github.com/chlohal/obsidian-terminal
A terminal panel for Obsidian
https://github.com/chlohal/obsidian-terminal
obsidian-md obsidian-plugin
Last synced: 3 days ago
JSON representation
A terminal panel for Obsidian
- Host: GitHub
- URL: https://github.com/chlohal/obsidian-terminal
- Owner: chlohal
- Created: 2022-06-04T17:19:29.000Z (almost 3 years ago)
- Default Branch: master
- Last Pushed: 2023-02-09T18:07:54.000Z (about 2 years ago)
- Last Synced: 2025-03-26T06:11:45.228Z (20 days ago)
- Topics: obsidian-md, obsidian-plugin
- Language: TypeScript
- Homepage:
- Size: 419 KB
- Stars: 13
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- project-awesome - chlohal/obsidian-terminal - A terminal panel for Obsidian (TypeScript)
README
# Obsidian Terminal
I *love* [Obsidian](https://obsidian.md). It's amazing to have a note-taking software that lets me work how I want to.
The only shortcoming of Obsidian is its Git integrations. There's a plugin, but I *really* prefer the terminal. And besides, having a terminal integration lets you do *everything!*
So I made this quick-and-dirty Obsidian Terminal :)
## Installing
If you have `git`, then you can clone this repository to your `.obsidian/plugins` folder.
If you don't have git, [download this .zip file](https://github.com/chlohal/obsidian-terminal/archive/refs/tags/1.0.0.zip). Extract the `.zip` folder to the `.obsidian/plugins` folder inside your vault.
The folder structure should look like this:
```
├─ .obsidian
│ ├─ obsidian-terminal
│ │ ├─ main.js
│ │ ├─ manifest.json
│ │ ├─ versions.json
│ │ └─ ..
│ └ ...other plugins...
└ ...note files...
```
After copying the files, restart Obsidian and it should work!
## Dependencies
- NodeJS (v16 or compatible). This should be installed by Electron
## Tools Used
**You don't need these as dependencies. This section is only included to give credit to the projects that made this possible**
- [xterm.js](https://github.com/xtermjs/xterm.js)
## Development
No build system necessary-- no typescript; no `npm run dev`.
~~no `require()` either because of how obsidian 'loads' plugins, but that's okay~~