Vault Code

Vault Code turns Obsidian into a workspace for notes, code, and files.

Vault Code is a powerful plugin that integrates with Obsidian's file explorer and editor. View hidden files, create and organize files of any kind, and write code in a beautiful code editor. Preview web pages, diagrams, and data, or work with AI agents without leaving Obsidian.

Vault Code follows your Obsidian display language and supports English, 繁體中文, 简体中文, 日本語, 한국어, Español, Français, Italiano, Deutsch, and Русский.

---

⚡ Features at a Glance

File explorer

• Hidden files & folders: Reveal dotfiles, dotfolders, and extensionless files.
• File creation & renaming: Create any file type or nested path; rename files and extensions.
• External folders (Desktop): Add folders from your disk by symlink.
• Ignore rules: Keep the explorer tidy with .obsidianignore and .gitignore.

Code editor

• Editing tools: Syntax highlighting, line numbers, folding, and familiar editing shortcuts.
• Markdown source editing: Switch between Obsidian's note view and the code editor.
• Find & replace: Search across lines with regex, case matching, and whole-word matching.
• Live preview: Render web pages, emails, diagrams, data tables, and diffs.
• Mobile & tablet support: Edit code and manage files on desktop, tablets, and phones.

Git (Desktop only)

• Git feature: Review diffs, keep or revert changes, and commit individual files.

Ask AI (Desktop only)

• Notes and code: Ask about your notes and code, or request edits in the sidebar.
• Flexible connections: Use coding CLIs, hosted APIs, or local model servers.

---

What you can do

✏️ Edit code right where you write notes

Open scripts, styles, and configuration files alongside your notes.

• 170+ file extensions supported: Python, JavaScript, TypeScript, Rust, Go, SQL, HTML, CSS, JSON, YAML, and more.
• Markdown source: Right-click a .md file and choose Edit in code editor, or click </> in the tab header. Useful for frontmatter, tables, and regex edits.
• Familiar controls: Line numbers, bracket matching, code folding, line duplication, commenting, and go-to-line.
• Native foundation: Built on Obsidian's editor engine, with your theme, font size, and light or dark mode.

👁️ See your hidden dotfiles and configs

• Reveal .gitignore, .env, .dockerignore, and .github/ in the file explorer.
• Open extensionless files such as Makefile, Dockerfile, LICENSE, and CNAME.
• Hide .git, node_modules, and other clutter with ignore rules.

🌐 Preview files beside your code

Switch between code and preview with the Preview button or Toggle code / preview command.

• Render HTML, SVG, and MJML, including linked styles and images.
• View Mermaid diagrams, JSON, CSV/TSV, JSONL/NDJSON, and diff/patch files.
• Edit supported table cells with Apply or Cancel. Invalid or ambiguous data stays read-only.

🔍 Find & replace

Press Cmd / Ctrl + F to search, or Cmd / Ctrl + H to replace.

• Search across multiple lines and jump between matches with a live count (1 of 14).
• Toggle case matching (Aa), whole words (\b), or regular expressions (.*).

📂 Create, rename & organize files

Right-click a file or folder in the explorer:

• New note here: Create a Markdown note in that folder.
• New folder here: Name a folder directly in the explorer.
• New file here (any extension): Create any file type, including dotfiles and nested paths such as src/components/Button.tsx.
• Edit file name and extension...: Rename files or change their extensions with built-in validation.
• Add external folder by symlink (Desktop): Choose any folder on your disk and link it into your vault without leaving Obsidian.

🌿 Review changes with Git (Desktop)

When your vault is inside a Git repository:

• Compare file contents with the last commit directly in the editor.
• Jump between changes and keep or revert individual hunks.
• See the current branch and changed-file count in the status bar.
• Commit an individual file with a message, or discard its changes.

✨ Ask AI (Desktop)

Ask AI about notes and code in the sidebar. Choose a connection in settings:

• CLI: Use Claude Code, Codex, Copilot, and other coding agents with their workspace tools. Install and update agents from settings.
• API: Bring your own key for OpenAI, Anthropic, Gemini, DeepSeek, Qwen, or another provider. Custom endpoints and model IDs are supported.
• Local: Connect Ollama, Atomic Chat, LM Studio, CC Switch, or another compatible server.

Attach notes or selections, pin context, and guide AI responses with a customizable instructions.md note in your chat folder. Revisit Markdown chat histories anytime.

🛡️ Control editing and file opening

• Single-clicking unsupported files selects them. Opening them in your system's default app on double-click is optional and disabled by default.
• Disable auto-save to save manually with Cmd / Ctrl + S. A dot ● marks unsaved changes, and closing an unsaved tab prompts you. Quitting Obsidian still saves unsaved edits.
• File management and code editing work on desktop, mobile, and tablets. Git, Ask AI, and adding external folders require desktop Obsidian.

---

Shortcuts

Shortcut	Action	Where
Cmd / Ctrl + F	Find text	Code editor
Cmd / Ctrl + H	Find and replace	Code editor
Ctrl + G	Go to line	Code editor
Cmd / Ctrl + /	Toggle line comment	Code editor
Shift + Option / Alt + A	Toggle block comment	Code editor
Option / Alt + ↑ / ↓	Move line	Code editor
Shift + Option / Alt + ↑ / ↓	Duplicate line	Code editor
Cmd / Ctrl + Shift + K	Delete line	Code editor
Alt + Z	Toggle line wrapping	Code editor
Cmd / Ctrl + S	Save file	Code editor
Esc	Close search or dismiss a popup	Relevant editor or dialog

Assign custom shortcuts to Vault Code: Ask AI or Vault Code: Toggle code / preview in code editor in Settings → Hotkeys.

---

Installation

From Obsidian Community Plugins (Recommended)

1. Open Settings → Community plugins and turn off Restricted mode.
2. Click Browse and search for Vault Code.
3. Click Install, then Enable.

Via BRAT

To test pre-release builds or update directly from GitHub:

1. Install and enable the BRAT plugin from Community Plugins.
2. In BRAT settings, click Add Beta plugin and enter SPACESODA/obsidian-vault-code.

Manual installation

1. Download main.js, manifest.json, and styles.css from the latest GitHub Release.
2. Create .obsidian/plugins/vault-code/ inside your vault and copy those three files into it.
3. In Obsidian, open Settings → Community plugins, refresh the list, and enable Vault Code.

---

Privacy & Network Disclosure

Vault Code sends no analytics or telemetry. Network activity depends on what you use:

• Ask AI: CLI agents contact their configured services. API and local connections send prompts, chat history, and attached note or selection context to your chosen endpoint. A loopback endpoint runs on your device; its server may also route to cloud providers.
• CLI installation & updates: Contact the agent's installer or package registry.
• Live preview: HTML can run JavaScript and load remote resources. Remote CSS, fonts, images, or scripts may make network requests.
• External links: Settings links open in your default browser.

---

License

Brought to you by SPACESODA under the GNU AGPLv3 License.