dsh-at-file README

The project's README from github.com/FSMargoo/dsh-at-file. As one markdown file: README.md.

dsh-at-file

[!IMPORTANT] The latest official DeepSeek Harness release now includes built-in @file and @session reference features. Prefer the official implementation for new installations. This plugin remains available for existing setups and will be maintained occasionally on a best-effort basis.

Workspace path references for the DeepSeek Harness web interface. Type @ in the composer to search the current workspace and insert a file or directory path.

@ path picker

File reference in the composer

Usage

Choose a result from the @ menu. The selected path remains visible in the draft and can be opened or removed from the reference bar.

Review @docs/spec.pdf

Before the agent starts a step, the plugin confirms that the path exists inside the active workspace. It then adds a short reference message:

<workspace-reference path="docs/spec.pdf" kind="file" />

The reference contains the workspace-relative path and its kind. The plugin does not open the referenced file or list the contents of a referenced directory. The agent can inspect the path with the tools available in the current session when the task requires it.

Pasted text is treated as ordinary text by default. An @path copied from another application does not open the picker, appear in the reference bar, or create a workspace-reference marker. Turn off Ignore @ mentions in pasted text in Settings -> File mentions if you need the older behavior.

File format and file size do not change this behavior. A PDF follows the same path-reference flow as any other workspace file.

This mechanism applies to version 0.3.0 and later. Earlier releases read file content during submission and enforced file-size limits.

Path Picker

Plain queries match filenames. Exact names, prefixes, and compact matches rank ahead of looser results, without matching letters scattered across a long directory path.

With an empty query, shallow paths appear before deeper entries; directories appear before files at the same depth. The scrollable menu exposes up to 50 candidates, so root-level files are not displaced by deeply nested directories.

A query containing / matches path segments in order. For example, src/view can find src/client/view.ts. A trailing slash such as src/ searches within that path.

When a directory is highlighted, press ArrowRight to enter it. The draft advances to @path/ without a trailing space, and the candidate menu stays open for the next selection. Enter and pointer selection keep the existing behavior and finish the directory reference.

Each result shows the complete filename first and its parent directory underneath. The menu expands to its 537px design width when space permits, and long filenames wrap instead of being ellipsized. Duplicate filenames also include the parent directory in the main label. Built-in SVG icons distinguish folders, source files, text, PDFs, images, data and configuration files, archives, and other files.

The default index skips common version-control directories, IDE metadata, dependency trees, caches, and build output. The list covers VS Code, Visual Studio, JetBrains IDEs, Fleet, Eclipse, Android and Gradle, Xcode, CMake, Flutter, .NET, Unity, Unreal, and common JavaScript and Python output directories. OS metadata files named desktop.ini, Thumbs.db, and .DS_Store are excluded by default.

Install or Update

dsh plugin --profile web add https://github.com/omdsh-dev/dsh-at-file/archive/refs/tags/v0.7.0.tar.gz

Use the same command to update an existing installation. Restart dsh web after installation so the Host and browser client load version 0.7.0.

Version 0.7.0 supports both the 0.1.1 and 0.1.2 Harness client package layouts. It also restores the default file ignores for installations that persisted an empty legacy list; clearing the list again in 0.7.0 remains an explicit choice.

File Filters

Open Settings -> File mentions to manage file-name filters.

File mention settings with Exact and Regex rules

Each rule has its own matching mode and case setting:

Rules are added and removed individually. An invalid regular expression is shown before saving and is also rejected by the Host. Restore defaults resets the global list to the built-in file names. Clear workspace rules removes only the selected workspace's additions.

Settings are saved in the DSH web profile through the plugin's own Host connection. Existing string values in ignoreFiles and workspace lists continue to work as case-insensitive Exact rules. A change clears the affected index cache, so the next @ search uses the saved rules.

Configuration

The available options apply to the path picker index:

Add the complete configuration to the selected profile's cordis.patch.yml. The usual path is ~/.dsh/profiles/web/cordis.patch.yml.

- id: dsh-at-file
  config:
    maxIndexedFiles: 10000

Omitting ignoreDirs keeps the built-in list. When you provide it, include every directory name you want excluded.

Path Handling

The active agent may lack a tool for a particular file format. DSH provides read for UTF-8 text and read_image for supported images. PDF support depends on the tools available in the session.

Development

pnpm install
pnpm run check
pnpm run test
pnpm run build

The development setup expects the official deepseek-ai/deepseek-harness repository at ../deepseek-harness, its default clone directory. Built files under lib/ are committed so profile installation does not require package build scripts.

License

MIT

dsh-at-file (FSMargoo/dsh-at-file)

Searching Database…

524 ·GitHub
Dsh-at-file
What is this?dsh-at-file is a DeepSeek Harness (DSH) plugin that adds Codex-style @file mentions to the web composer: type @ to search the current workspace and insert a file or directory path into your prompt.
Is this a standalone app or a plugin for something else?It is a plugin for DeepSeek Harness's web interface, not a standalone application; it only extends the composer's @ mention menu and reference bar.
How do I install or update it?Install it into your DSH profile and restart dsh web afterward; the same command is used to update an existing installation to a newer version.
Do I need DeepSeek Harness already running first?Yes, this plugin only works inside an existing DeepSeek Harness web setup; building it from source also requires cloning the official deepseek-ai/deepseek-harness repo as a sibling directory.
Should I still use this if I'm setting up DSH for the first time?No — the latest official DeepSeek Harness release ships built-in @file and @session references, so new installs should use that instead; this plugin stays available only for existing setups and gets best-effort maintenance.
Does pasting an @path from another app trigger the file picker?No, pasted text is treated as ordinary text by default and will not open the picker, appear in the reference bar, or create a workspace-reference marker unless that default setting is turned off.
How do the file-name filters work?Global rules apply to every workspace while workspace rules add extra filters for a single workspace; each rule matches by Exact basename or Regex and can optionally be case-sensitive.
Can the plugin open or read the files it references?No, it only confirms a path exists and inserts a short reference message; the agent has to use its own session tools (like read or readimage) to actually inspect the content.
Where do I tune settings like the max indexed files?Through the profile's cordis.patch.yml (typically ~/.dsh/profiles/web/cordis.patch.yml) using options like maxIndexedFiles and ignoreDirs.
What are similar projects?cocode, awesome-deepseek-harness, dsh-router-standard, dsh-plugin-bridge, oh-dsh, clearai-dsh, dsh-ops, dsh-agent-team-gui
Which topics is it in?file-management, yaml, dsh, harness, search, dsh-plugin, deepseek-harness, coding-agent, plugin, codex, productivity, agent
Creator
FSMargoo
Size
2.2 MB
Stars
524
Updated
CommitSep 01
Age
2mo
Commits · 90 Days