Embedded Terminal for Obsidian

A native embedded terminal plugin for Obsidian, powered by xterm.js and node-pty.

在 Obsidian 中提供一个真正的系统终端, 将命令行环境直接嵌入知识管理工作流.

本插件通过 xterm.js + node-pty + Windows ConPTY 实现完整终端体验, 支持实时交互、ANSI 输出、Shell 会话保持以及窗口自适应.

Embedded Terminal integrates a native PTY-powered terminal into Obsidian, allowing users to execute and manage command-line workflows directly inside their knowledge workspace.

---

Features

Embedded Terminal

将终端作为 Obsidian Workspace View 嵌入.

适用于：

• 编程开发
• Git 操作
• 数据分析
• 项目管理
• 命令行工具调用

---

Real PTY Support

采用真实 PTY 架构：

• xterm.js
• node-pty
• Windows ConPTY

支持：

• 交互式 Shell
• ANSI 彩色输出
• 光标控制
• Tab 补全
• Ctrl+C
• Python / Node / Git CLI

---

Architecture

Obsidian UI
    |
TerminalView.ts
    |
TerminalProcess.ts
    |
pty-host.cjs
    |
node-pty + ConPTY
    |
cmd.exe

---

Installation

npm install
npm run build

复制插件文件到：

.obsidian/plugins/embedded-terminal/

文件包含：

1. native/
2. main.js
3. manifest.json
4. pty-host.cjs
5. styles.css

重新加载 Obsidian.

---

Requirements

Platform	Status
Windows 10/11	Supported
Linux	Experimental

---

Usage

打开：

Command Palette
        ↓
Embedded Terminal: Open

默认快捷键(VSCode风格)：

Ctrl + `

隐藏终端时不会关闭后台 Shell.

---

Configuration

默认 Shell：

shell: "cmd.exe"

可修改为：

shell: "powershell.exe"

或：

shell: "pwsh.exe"

---

Roadmap

• Linux PTY support
• Multiple terminal tabs
• Terminal profiles
• SSH integration
• AI command assistant

---

Known Limitations

当前主要支持 Obsidian Desktop.

由于依赖系统终端能力：

• 不支持 Obsidian Mobile
• 不支持 Web 版本

Windows + ConPTY 为最佳体验.