Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
50 changes: 50 additions & 0 deletions .github/workflows/pages.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
name: Deploy Website

on:
push:
branches: [main]
paths:
- "docs/**"
- "assets/**"
- ".github/workflows/pages.yml"
workflow_dispatch:

permissions:
contents: read
pages: write
id-token: write

concurrency:
group: pages
cancel-in-progress: false

jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/setup-node@v4
with:
node-version: 24
cache: npm
cache-dependency-path: docs/package-lock.json
- name: Install website dependencies
run: npm ci
working-directory: docs
- name: Build website
run: npm run build
working-directory: docs
- uses: actions/configure-pages@v6
- uses: actions/upload-pages-artifact@v5
with:
path: docs/build

deploy:
needs: build
runs-on: ubuntu-latest
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
steps:
- id: deployment
uses: actions/deploy-pages@v5
5 changes: 5 additions & 0 deletions docs/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Synced by scripts/sync-assets.mjs, not committed
/static/img/preview.png

# Docusaurus build output (also covered by root .gitignore, kept for local runs)
/build/
25 changes: 25 additions & 0 deletions docs/docs/faq.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
sidebar_position: 4
---

# FAQ

### Does Qoderian work on mobile?

No. Qoderian is desktop-only (macOS, Linux, Windows) because it runs the local Qoder CLI, which needs full file system and shell access.

### Does Qoderian need an API key?

No. Sign-in is managed entirely by your local Qoder CLI (`qodercli login`); the plugin never asks for an API key.

### What are the requirements?

Obsidian v1.7.2+ and a signed-in Qoder CLI on the same machine. Windows on arm64 is not supported.

### Where does the agent work?

In your vault. Your vault is the agent's working directory, so file read/write, search, bash, and multi-step workflows work out of the box.

### How do I report a bug or request a feature?

Open an issue on [GitHub](https://github.com/QoderAI/qoderian/issues).
18 changes: 18 additions & 0 deletions docs/docs/features.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
sidebar_position: 3
---

# Features

- **Agentic chat** — qodercli streams responses into the sidebar and reads, writes, edits, and searches files in your vault.
- **`@` mentions** — Bring vault notes, the current selection, or external directories into context as removable chips.
- **Inline Edit** — Rewrite selected note text in place, with a diff preview before you accept.
- **Slash Commands & Skills** — `/` opens built-in and project-level commands; skills, agents, and hooks come from the same Qoder CLI project files as the terminal.
- **Permission Modes** — Ask approval, Auto approval, or Full access from the chat toolbar.
- **`#` Instruction Mode** — Write a custom instruction on an empty input; it is refined before being applied.
- **`!` Bash Mode** — Run a shell command in the vault directory; opt-in under Settings → Experimental.
- **Models & Effort** — Model picker with per-model reasoning effort and context usage reported by the Qoder Agent SDK.
- **MCP Servers** — Connect external tools over the Model Context Protocol (stdio, SSE, HTTP), configured in-app.
- **Tabs & History** — Multiple chat tabs with their own histories, plus resume, fork, and rewind.
- **Subagents** — Nested agent runs grouped and rendered inline.
- **Turn summaries** — Finished turns fold their working steps into an expandable "Execution steps" line, and edited files collapse into a card that opens a read-only per-file diff modal.
75 changes: 75 additions & 0 deletions docs/docs/installation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
---
sidebar_position: 2
---

# Installation

Qoderian is desktop-only (macOS, Linux, Windows) and needs Obsidian v1.7.2+ plus a signed-in [Qoder CLI](https://qoder.com).

## 1. Install and sign in to Qoder CLI

Install with the official script (recommended):

**macOS / Linux**

```bash
curl -fsSL https://qoder.com/install | bash
```

**Windows — PowerShell** (Windows Terminal recommended)

```powershell
irm https://qoder.com/install.ps1 | iex
```

Or through npm (requires Node.js ≥ 20):

```bash
npm install -g @qoder-ai/qodercli
```

The installer puts `qodercli` on your PATH; Windows on arm64 is not supported. Then sign in from a terminal:

```bash
qodercli login
```

Sign-in is managed entirely by your local CLI; Qoderian never asks for an API key.

## 2. Install the plugin

### From Obsidian Community Plugins (recommended)

1. Open Obsidian → Settings → Community plugins → Browse
2. Search for "Qoderian" and click Install
3. Enable the plugin

### From GitHub Release

1. Download `main.js`, `manifest.json`, and `styles.css` from the [latest release](https://github.com/QoderAI/qoderian/releases/latest)
2. Create a folder called `qoderian` in your vault's plugins folder:
```
/path/to/vault/.obsidian/plugins/qoderian/
```
3. Copy the downloaded files into that folder
4. Enable the plugin in Obsidian: Settings → Community plugins → turn off Restricted mode → enable "Qoderian"

### From source

1. Clone the repository into your vault's plugins folder:
```bash
cd /path/to/vault/.obsidian/plugins
git clone https://github.com/QoderAI/qoderian.git qoderian
cd qoderian
```
2. Install dependencies and build:
```bash
npm ci
npm run build
```
This writes `main.js` and `styles.css` next to `manifest.json`, which is where Obsidian loads them from.
3. Enable the plugin in Obsidian

## 3. Start using

Open the chat sidebar from the ribbon icon or the command palette (`Open Qoderian`). Type a message and press **Enter**; qodercli streams its response back into the panel and works on your vault files just like the terminal CLI.
25 changes: 25 additions & 0 deletions docs/docs/introduction.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
sidebar_position: 1
slug: /introduction
---

# Introduction

Qoderian is an Obsidian plugin that embeds [Qoder CLI](https://qoder.com) (`qodercli`) in your vault. Your vault becomes the agent's working directory — file read/write, search, bash, and multi-step workflows all work out of the box.

![Qoderian in an agentic Obsidian workspace](pathname:///qoderian/img/preview.png)

## Highlights

- **Agentic chat** — qodercli streams responses into the sidebar and reads, writes, edits, and searches files in your vault.
- **`@` mentions** — Bring vault notes, the current selection, or external directories into context as removable chips.
- **Inline Edit** — Rewrite selected note text in place, with a diff preview before you accept.
- **Slash Commands & Skills** — `/` opens built-in and project-level commands; skills, agents, and hooks come from the same Qoder CLI project files as the terminal.
- **Tabs & History** — Multiple chat tabs with their own histories, plus resume, fork, and rewind.

See [Features](./features.md) for the full list, or jump straight to [Installation](./installation.md).

## Requirements

- Obsidian **v1.7.2+** on desktop (macOS, Linux, or Windows — mobile is not supported)
- A signed-in [Qoder CLI](https://qoder.com) on the same machine
68 changes: 68 additions & 0 deletions docs/docusaurus.config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
// @ts-check
// Docusaurus config for the Qoderian website (GitHub Pages).
// The site lives inside docs/: curated pages under docs/docs/, while the
// repository markdown at the root (README, CHANGELOG, ...) stays canonical.

/** @type {import('@docusaurus/types').Config} */
const config = {
title: "Qoderian",
tagline: "Qoder CLI embedded in your Obsidian vault.",
url: "https://qoderai.github.io",
baseUrl: "/qoderian/",
organizationName: "QoderAI",
projectName: "qoderian",
trailingSlash: false,

onBrokenLinks: "throw",

i18n: {
defaultLocale: "en",
locales: ["en", "zh-Hans"],
localeConfigs: {
en: { label: "English" },
"zh-Hans": { label: "简体中文" },
},
},

presets: [
[
"classic",
/** @type {import('@docusaurus/preset-classic').Options} */
({
docs: {
sidebarPath: "./sidebars.js",
editUrl: "https://github.com/QoderAI/qoderian/edit/main/docs/",
},
blog: false,
theme: {
customCss: "./src/css/custom.css",
},
}),
],
],

themeConfig:
/** @type {import('@docusaurus/preset-classic').ThemeConfig} */
({
navbar: {
title: "Qoderian",
items: [
{
type: "localeDropdown",
position: "right",
},
{
href: "https://github.com/QoderAI/qoderian",
label: "GitHub",
position: "right",
},
],
},
footer: {
style: "dark",
copyright: `Copyright © ${new Date().getFullYear()} Qoder. Built with Docusaurus.`,
},
}),
};

export default config;
6 changes: 6 additions & 0 deletions docs/i18n/zh-Hans/code.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"tagline": {
"message": "嵌入 Obsidian 仓库的 Qoder CLI。",
"description": "The tagline shown in the footer and meta description"
}
}
25 changes: 25 additions & 0 deletions docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/faq.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
sidebar_position: 4
---

# 常见问题

### Qoderian 支持移动端吗?

不支持。Qoderian 仅支持桌面端(macOS、Linux、Windows),因为它要运行本地 Qoder CLI,需要完整的文件系统和 shell 权限。

### Qoderian 需要 API key 吗?

不需要。登录完全由本地 Qoder CLI(`qodercli login`)管理;插件不会索要 API key。

### 环境要求是什么?

Obsidian v1.7.2+,以及同一台机器上已登录的 Qoder CLI。暂不支持 Windows arm64。

### 智能体在哪里工作?

在你的仓库(vault)里。仓库就是智能体的工作目录,文件读写、检索、bash 和多步工作流都开箱即用。

### 如何报告问题或提功能建议?

请在 [GitHub](https://github.com/QoderAI/qoderian/issues) 上提 issue。
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
sidebar_position: 3
---

# 功能

- **智能体聊天** — qodercli 以流式方式把回复送回侧栏,并读取、写入、编辑、搜索仓库中的文件。
- **`@` 引用** — 把仓库笔记、当前选区或外部目录加入上下文,显示为可移除标签。
- **Inline Edit** — 就地改写选中的笔记文字,接受前先给出 diff 预览。
- **Slash Commands & Skills** — `/` 打开内置与项目级命令;skills、agents、hooks 与终端共用同一套 Qoder CLI 项目文件。
- **Permission Modes** — 在聊天工具栏选择询问审批、自动审批或完全访问。
- **`#` 指令模式** — 空输入框中编写自定义指令,先润色再应用。
- **`!` Bash 模式** — 在仓库目录运行 shell 命令;需在设置 → 实验性功能中启用。
- **模型与强度** — 模型选择器按模型调节推理强度,并显示 Qoder Agent SDK 上报的上下文用量。
- **MCP Servers** — 通过 Model Context Protocol(stdio、SSE、HTTP)连接外部工具,应用内配置。
- **标签与历史** — 多个聊天标签各自保有历史,支持续接、分叉、回退。
- **Subagents** — 嵌套的智能体运行分组内联渲染。
- **回合摘要** — 完成的回合把执行过程折叠成可展开的「执行步骤」行;编辑过的文件折叠成卡片,点击打开只读的逐文件 diff 弹窗。
Loading
Loading