xiantong 文档
来源

本地文件夹

为快速访问和记录文档而书签您机器上的文件夹

将机器上的目录书签化，便于快速访问和记录文档

本地文件夹是指向您机器上目录的书签。它们提供一个命名引用，出现在您的来源列表中，并可通过 guide.md 添加可选文档说明。

无需特殊设置。 本地文件夹使用与任何路径相同的读取、写入、Glob 和 Grep 工具。其价值在于组织与文档化。

何时使用本地文件夹#

需求解决方案
在单个项目目录工作使用 工作目录
书签多个文件夹使用本地文件夹
记录文件夹内容和约定使用带有 guide.md 的本地文件夹

配置#

创建一个带 config.json 的来源文件夹：

{
"type": "local",
"name": "My Notes",
"slug": "my-notes",
"enabled": true,
"provider": "local",
"local": {
"path": "/Users/me/Documents/Notes"
}
}

字段#

字段描述
type必须为 "local"
name在来源列表中显示的名称
slugURL 安全的标识符（用作文件夹名）
enabled来源是否启用
provider服务标识符，使用 "local"
local.path指向文件夹的绝对路径

可选：格式提示#

您可以添加格式提示，帮助 xiantong 理解文件夹内容：

{
"type": "local",
"name": "Obsidian Vault",
"slug": "my-vault",
"provider": "obsidian",
"local": {
"path": "/Users/me/Documents/ObsidianVault",
"format": "obsidian"
}
}

添加本地文件夹#

最简单的方法是请求 xiantong：

“将我的桌面文件夹添加为来源”

或手动创建：

  1. 创建来源文件夹：
~/.xiantong/workspaces/{workspace-id}/sources/my-folder/
  1. 添加带上述配置的 config.json
  2. 可选地添加包含文件夹背景信息的 guide.md

guide.md 示例#

guide 帮助 xiantong 理解文件夹内容以及如何使用：

# Desktop

Temporary files and downloads. Check here for recent screenshots and exports.

## Contents
- Screenshots from CMD+Shift+4
- Downloaded PDFs and documents
- Temporary exports from apps

## Conventions
- Screenshots go in /Screenshots subfolder
- Delete files older than 1 week
- Don't commit anything from here to git

探索模式权限#

默认情况下，本地文件夹在探索模式下使用标准的只读 Bash 命令（ls、cat、head、tail 等）。如需定制，可添加 permissions.json：

{
"allowedBashPatterns": [
{ "pattern": "^ls\\s", "comment": "列出内容" },
{ "pattern": "^tree\\s", "comment": "显示目录结构" }
]
}

本地文件夹与工作目录#

为您的使用场景选择合适方法：

工作目录#

您的活跃项目。每次会话设置一次。用于编码、构建和测试的完整工具访问。适用于：您当前正在处理的项目。

本地文件夹#

您偶尔参考的文件夹书签。 带有名称来源和文档说明。适用于：笔记、下载、参考资料。

经验法则： 编码时使用工作目录。其他所有情况使用本地文件夹。

上一页概览