Skip to content

huzhicheng/ObsiTerm

Repository files navigation

ObsiTerm

A terminal plugin for Obsidian, making it easy to use Claude Code, Codex, Gemini CLI, and other command-line tools directly inside Obsidian.

简体中文

version license platform follow

ObsiTerm Preview

Overview

ObsiTerm opens a real terminal in the right sidebar of Obsidian Desktop. You can use it like any other terminal, including running Claude Code, Codex, Gemini CLI, and other command-line workflows.

Features

  • A terminal integrated into Obsidian, so you can use Claude Code, Codex, Gemini CLI, and other CLI tools directly inside Obsidian with real-time interaction.
  • Fully compatible with Ghostty terminal themes. You can copy Ghostty theme files directly into the themes directory, open it from the settings page, and switch themes from the plugin settings.
  • Comes with 9 built-in themes
Light Theme Dark Theme
Light Theme Dark Theme
  • Supports @ file search without interfering with native commands in Claude Code, Codex, or Gemini CLI
  • Configurable font, font size, and file-path autocomplete trigger
  • Supports folding large pasted text blocks and pasting images as temporary file paths, similar to Claude Code

Usage

Installation

Download the package for your platform from Releases (currently macOS only).

Automatic installation

Unzip the package and enter the directory

chmod +x install.sh
./install.sh

It will automatically find Obsidian vaults on the current machine, list them, and let you select one or more vaults with the space key, then press Enter to install.

Auto Install

Manual installation

Download the archive, extract it, and copy the ObsiTerm folder into the .obsidian/plugins/ directory of your vault.

Enable and configure

In Obsidian Settings, open Community plugins, find ObsiTerm, and enable it.

turn on

In the settings page, you can configure the theme, font size, font family, autocomplete trigger, and more.

setting

Open terminal

Click the New Terminal icon in the left sidebar to open a terminal.

new Terminal

@ autocomplete

  1. Type @
  2. Continue typing keywords
  3. Use / to select
  4. Press Tab or Enter to confirm
  5. Press Esc to cancel

The selected item is inserted as an absolute path.

Settings

Available options:

  • Theme
  • Reload themes
  • Font size
  • Font family
  • Autocomplete trigger

Theme files are located in themes/.

License

MIT

About

An Obsidian terminal

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors