Obsidian Copilot

A collection of productivity tools for Obsidian, designed to enhance your note-taking experience.

Features

HTTP Server - Browse Vault in Browser

Access and browse your Obsidian vault through a web browser with a beautiful, modern interface.

Key Features:

Directory browsing: Navigate through your vault's folder structure
File preview: View Markdown files with rendered preview and source toggle
Text file support: View various text file formats (JSON, JS, TS, CSS, etc.)
Modern UI: Dark theme with responsive design, similar to online documentation sites
Breadcrumb navigation: Easy navigation with clickable path breadcrumbs

Installation

Manual Installation

Download main.js, manifest.json, and styles.css from the latest release
Create a folder obsidian-copilot in your vault's .obsidian/plugins/ directory
Copy the downloaded files into this folder
Restart Obsidian and enable the plugin in Settings → Community plugins

Usage

Starting the Server

Ribbon icon: Click the globe icon (🌐) in the left ribbon
Command palette: Use Ctrl/Cmd + P and search for "Start HTTP server"
Auto-start: Enable in settings to start automatically when Obsidian loads

Accessing Your Vault

Once the server is running:

Open your browser
Navigate to http://127.0.0.1:8080 (or your configured port)
Browse your vault's directories and files

Configuration

Open Settings → Obsidian Copilot to configure:

Enable HTTP Server: Toggle the feature on/off
Port: Change the server port (default: 8080)
Auto-start: Start server automatically when plugin loads

Commands

Command	Description
`Start HTTP server`	Start the HTTP server
`Stop HTTP server`	Stop the HTTP server
`Open vault in browser`	Open the vault in your default browser

Development

Prerequisites

Node.js 18+
npm

Setup

# Install dependencies
npm install

# Development build (watch mode)
npm run dev

# Production build
npm run build

# Deploy to Obsidian (build + copy files)
npm run deploy

Deploy to Obsidian

To automatically deploy built files to your Obsidian vault:

Copy .env.example to .env:
```
cp .env.example .env
```

Edit .env and set your plugin directory:

OBSIDIAN_PLUGIN_DIR=D:\MyVault\.obsidian\plugins\obsidian-copilot

Run deploy:
```
npm run deploy
```

This will build the plugin and copy main.js, manifest.json, and styles.css to your Obsidian plugin folder.

Project Structure

src/
  main.ts           # Plugin entry point
  settings.ts       # Settings interface and tab
  types.ts          # TypeScript type definitions
  http-server/      # HTTP Server module
    index.ts        # Module exports
    server.ts       # HTTP server implementation
    routes.ts       # Request routing and handlers
    templates.ts    # HTML templates

Security Notes

The HTTP server only binds to 127.0.0.1 (localhost) by default
Only accessible from your local machine
No authentication is required since it's local-only
Be cautious if you modify the binding address

License

AGPL-3.0