OpenSpec with enhanced Obsidian integration - AI-native system for spec-driven development
npm install openspec-obsidian-enhancedOpenSpec with enhanced Obsidian integration - Spec-driven development for AI coding assistants.

Follow @0xTab on X for updates · Join the OpenSpec Discord for help and questions.
OpenSpec Obsidian Enhanced 是 OpenSpec 的增强版本,专门为 Obsidian 用户优化,提供了深度的 Obsidian 集成功能。它将规范驱动的开发流程与 Obsidian 的知识管理能力完美结合。
tasks.md、任务列表.md、タスクリスト.mdopenspec obsidian 命令组管理配置``bash`
npm install -g @openspec/obsidian-enhanced
首先确保你已经安装了 Obsidian Local REST API 插件。
`bash初始化项目(会自动弹出配置向导)
openspec init
$3
`bash
创建变更提案
openspec new change "用户认证功能"查看所有变更
openspec list显示变更详情
openspec change show "用户认证功能"
`📖 详细使用指南
$3
#### 查看当前配置
`bash
openspec obsidian show
`#### 重新配置
`bash
openspec obsidian configure
`#### 清除本地配置
`bash
openspec obsidian clear
`$3
如果你想使用环境变量而不是配置文件:
`bash
export OPENSPEC_OBSIDIAN_URL="https://localhost:27125"
export OPENSPEC_OBSIDIAN_API_KEY="your-api-key"
export OPENSPEC_OBSIDIAN_VAULT_PATH="your-project"
export OPENSPEC_STORAGE="obsidian"
`$3
OpenSpec Obsidian Enhanced 支持多种语言:
`bash
中文项目
openspec init --locale zh-CN日文项目
openspec init --locale ja英文项目(默认)
openspec init --locale en
`不同语言会生成对应的文件名:
- 英文:
tasks.md
- 中文:任务列表.md
- 日文:タスクリスト.md$3
#### 本地模式
`
project/
└── openspec/
├── README.md
├── project.md
├── AGENTS.md
├── specs/
└── changes/
└── change-name/
├── proposal.md
└── 任务列表.md
`#### Obsidian 模式
`
project/
└── openspec/
└── project-name/
├── README.md
├── project.md
├── AGENTS.md
├── specs/
└── changes/
└── change-name/
├── proposal.md
└── タスクリスト.md
`🔧 高级功能
$3
结合 Obsidian 的 Dataview 插件,你可以创建强大的项目仪表板:
`markdown
项目概览
`dataview
TABLE
file.mtime as "修改时间",
choice(file.tasks.tasks.length > 0, "✅", "❌") as "任务"
FROM "openspec/project/changes"
SORT file.mtime DESC
`$3
在 Obsidian 中创建模板,快速生成标准化的变更提案:
`markdown
---
template: change-proposal
---{{title}}
背景
目标
实现方案
验收标准
`$3
使用 Obsidian 的 Templater 插件,可以自动化创建任务:
`javascript
<%*
const title = await tp.system.prompt("变更标题")
const tasks = await tp.system.prompt("任务列表(每行一个)")
await tp.file.create_new(# ${title}\n\n## 任务\n${tasks.split('\n').map(t => - [ ] ${t}).join('\n')}, openspec/project/changes/${title}/proposal.md)
%>
`📚 命令参考
$3
| 命令 | 描述 |
|------|------|
|
openspec init | 初始化项目 |
| openspec list | 列出所有变更 |
| openspec new change | 创建新变更 |
| openspec change show | 显示变更详情 |
| openspec change archive | 归档变更 |$3
| 命令 | 描述 |
|------|------|
|
openspec new spec | 创建新规范 |
| openspec spec show | 显示规范详情 |
| openspec spec validate | 验证规范 |$3
| 命令 | 描述 |
|------|------|
|
openspec obsidian show | 显示 Obsidian 配置 |
| openspec obsidian configure | 配置 Obsidian |
| openspec obsidian clear | 清除配置 |🔒 安全性
- API Key 保护:配置文件中的 API Key 在显示时会隐藏
- 本地存储:所有配置都存储在本地,不会上传
- Git 忽略:敏感配置文件自动添加到
.gitignore`欢迎贡献代码!请查看 贡献指南。
MIT License - 查看 LICENSE 文件了解详情。
- OpenSpec 官方仓库
- Obsidian Local REST API
- OpenSpec Discord
遇到问题?:
1. 查看 常见问题
2. 搜索 Issues
3. 在 Discord 中提问
---
Built with ❤️ by the OpenSpec community