# Agent File Pane

Hides `AGENTS.md`, `CLAUDE.md`, `GEMINI.md` (and any other filenames you
choose) from the Obsidian file explorer and lists them in a dedicated side
pane that mirrors the folder tree.

![Agent File Pane in action](docs/screenshot.png)

These instruction files clutter the file explorer when used at multiple folder
levels, but you still want them accessible. This plugin keeps them out of the
way while making them easy to jump to.

## Features

- **Hide files in the explorer.** Files matching the tracked filenames are
  hidden at any depth via a runtime stylesheet. Files like `MY_AGENTS.md` are
  not affected — only exact filename matches.
- **Side pane with a folder tree.** A right-sidebar view (`Agent Files`) shows
  every tracked file in its actual folder hierarchy, so you can orient by
  location at a glance. Click a file to open it.
- **Configurable filenames.** Add or remove tracked filenames from the
  settings tab. Defaults are `AGENTS.md`, `CLAUDE.md`, and `GEMINI.md`.
- **Stays in sync.** The pane re-renders automatically on file create, delete,
  and rename.

## Usage

Open the pane from the ribbon (`bot` icon) or from the command palette
("Agent File Pane: Open pane"). Cmd/Ctrl-click a file to open it in a new
leaf.

## Settings

Settings → Agent File Pane:

- **Tracked filenames.** Add filenames to track, remove existing ones, or
  reset to the defaults. Matching is case-sensitive and exact (not pattern-
  based).

## Installation

### From the community plugin browser

Once accepted into the community catalog, install from Settings → Community
plugins → Browse → search "Agent File Pane".

### Manual install

1. Download `manifest.json`, `main.js`, and `styles.css` from the latest
   release.
2. Place them in `<vault>/.obsidian/plugins/agent-file-pane/`.
3. Enable the plugin from Settings → Community plugins.

## Development

```bash
npm install
npm run dev      # esbuild watch mode
npm run build    # type-check + production build
```

For live testing, symlink the repo into a vault's plugins folder:

```bash
ln -s "$(pwd)" /path/to/vault/.obsidian/plugins/agent-file-pane
```

## License

MIT — see [LICENSE](LICENSE).