README file from
GithubFeatures
Session-scoped Codex Workspace
- Opens Codex in the Obsidian sidebar.
- Requires a folder picker for ordinary chat sessions before sending.
- Treats attached notes as turn context only; attaching a note does not make the whole vault the workspace.
- Keeps the
Knowledgechannel bound to the current vault for Raw, Wiki, Outputs, and Inbox maintenance. - Lets Codex read files, inspect folders, edit documents, and run local commands.
- Keeps the workflow inside Obsidian instead of bouncing between apps.
Agent-style Process Timeline
- Renders reasoning, commands, file edits, MCP calls, and context usage as readable process cards.
- Shows file chips for touched files, with vault files opening back in Obsidian.
- Keeps large outputs and raw details folded away so the conversation stays readable.
- Supports Agent / Plan mode, model selection, reasoning effort, speed, and file permission modes.
Knowledge Base Operations
- Adds a persistent
Knowledgechannel for maintaining the current Obsidian vault. - Treats chat as the main control surface: type
/init,/ask,/check,/maintain,/outputs,/journal, or/inbox, then add your own instruction after the command. - Adds an LLM Wiki initialization guide:
/initpreviews folders, rules files, and existing-note routing suggestions;/init confirmcreates the template. - Answers read-only knowledge questions with
/ask, searching Wiki first and then using Journal / Outputs as background evidence, while separating Vault evidence from external or model-based supplements. - Writes daily journals with
/journal, following the currentjournal/folder layout and recent note format; the workday window is00:00through before next-day06:00, with Codex CLI reading Codex sessions and OpenCode API reading OpenCode chat history. - Shows Codex CLI knowledge-base runs with the same process cards as regular Agent chats: reasoning, commands, file changes, tool calls, and final results.
- Shows a pinned Knowledge health dashboard above the channel: rules file, Raw/Wiki/Inbox counts, health status, detailed Wiki folder table, Raw/Inbox table, and a full-year check heatmap.
- Reads
LLM-WIKI.mdas the knowledge-base rules source by default;AGENTS.mdremains runtime background for Codex/OpenCode. - Optionally recommends
codex-memory-litefor longer-lived knowledge context; your Agent installs the skill and runs its bootstrap in the workspace, while the plugin does not bundle the skill or modify yourAGENTS.md. - Collects WeChat articles, web pages, and text files into Raw Sources before processing.
- Keeps existing Raw files unchanged, then writes structured results to Wiki, Outputs, Journal, and tracker files.
- Supports manual runs and daily maintenance when Obsidian is open.
Weekly Reviews
- Adds a
Reviewsettings tab, with scheduled automation disabled by default. - Lets you enable
KnowledgeandAgent chatweekly reviews separately. - Runs by default every Sunday at 21:00, with catch-up the next time Obsidian opens.
- Writes Markdown and matching HTML files to
outputs/obsidian-weekly-review/. - Uses a fixed HTML dashboard template and opens it through EchoInk's built-in preview.
Local-first Integration
- Reuses your local Codex CLI login state.
- Does not require storing an OpenAI API key by default.
- Optionally supports OpenAI Responses API-compatible custom providers, including multiple models per provider.
- Supports local proxy settings for the Codex child process.
- Keeps plugin, MCP, and skill switches scoped to the current vault instead of rewriting global Codex config.
- Adds search to the current-vault plugin, MCP, and skill switches, with long labels clipped cleanly so the enable checkbox stays reachable.
OpenCode API Mode
- Keeps the original Codex CLI mode for users who want to reuse local Codex login state.
- Adds OpenCode API mode for knowledge base tasks when OpenCode is installed locally.
- Can detect or connect to an OpenCode server, refresh available models, and choose the active OpenCode model.
- Can refresh and choose OpenCode Agents, so different knowledge management workflows can use different agent profiles.
Writing Context Harness
- Adds in-editor rewrite, expand, continue, and translate-to-English actions for selected text.
- Lets you choose
Fast,Quality, orStrictwriting quality modes. - Uses visible article understanding for long-form context instead of silently running background summaries.
- Shows a writing context panel with the current note, model, understanding status, and structured article understanding.
- Reuses article understanding after small edits, so continuous rewrite / expand / continue / translate runs do not repeatedly re-read the whole note.
- Shows an inline candidate that can be accepted with
Enteror canceled withEsc.
This feature is still experimental and disabled by default, but v0.3.0 makes it a much more deliberate writing workflow.
Why EchoInk
Codex EchoInk turns ink into a codex, then lets it echo back as new ideas.
Inkis the record: notes, clippings, drafts, sources, and conversations.Codexis the knowledge base: structured wiki pages, indexes, reports, and traceable source links.Echois the activation layer: vault-aware questions, maintenance runs, writing help, and future inspiration workflows.
The name matches the Obsidian loop: record, organize, and get prompted into the next thought.
What's New
v0.5.2
Knowledge workflow and Windows diagnostics update: adds weekly review reports, improves /journal, makes Knowledge runs easier to inspect, and fixes the bad gpt-5.5 default that could trigger Windows WebSocket failures.
New features:
- Added Knowledge and Agent chat weekly reviews, with scheduled or manual runs and Markdown + HTML output in
outputs/obsidian-weekly-review/. - Added an EchoInk HTML preview for generated weekly review reports.
- Added
/weekand/week agentshortcuts in the Knowledge channel. - Upgraded
/journalto write into the currentjournal/daily/YYYY-MM/YYYY-MM-DD-周X.mdlayout, create missing journal folders, and use a fixed00:00to next-day06:00work window. - Added OpenCode chat-history collection for
/journalwhen the Knowledge backend uses OpenCode API. - Expanded
/askevidence fromwiki/towiki/,journal/, andoutputs/, with citation buckets, excerpt lines, relevance, and match reasons. - Added a settings language switch for Chinese / English settings UI.
Fixes:
- Changed the Codex CLI default model to
Auto; existing savedgpt-5.5defaults are migrated toAuto. - Removed remaining hard-coded
gpt-5.5fallback paths from Knowledge tasks and Plan mode. - Added detailed Codex diagnostics for WebSocket, proxy refusal, missing CLI, timeout, and app-server exit errors.
- Added Windows
responses_websocket/os error 10061troubleshooting guidance. - Simplified Review settings so manual report generation has confirmation and clearer output paths.
- Shows Codex CLI Knowledge runs through the normal process timeline, so reasoning, commands, file edits, and final results stay in one visible flow.
- In the Knowledge channel, ordinary messages now stay as normal Agent chat. Only explicit
/ask,/query,/问, or/查询commands trigger Knowledge Q&A. - The Knowledge channel primary button now stops ordinary Agent chat when that chat is running, instead of canceling Knowledge maintenance by mistake.
- Knowledge failures now keep more complete app-server, JSON-RPC, OpenCode, and turn error details for easier troubleshooting.
- Local vault note paths and report paths in Knowledge replies render as clickable note links.
v0.5.1
Community review fix: removed the redundant word Obsidian from manifest.json description and dropped the legacy main manifest field to satisfy automated community checks.
v0.5.0
Community-ready release: renamed the plugin to Codex EchoInk, prepared the codex-echoink community plugin id, and added clearer privacy and permission disclosures for Obsidian review.
What changed:
- Renamed the plugin from
Codex for Obsidian/obsidian-codextoCodex EchoInk/codex-echoink. - Updated install paths, release links, packaging output, and visible repository references for the new community name.
- Kept compatibility with large raw message files stored by older manual installs under
.obsidian/plugins/obsidian-codex/raw. - Added privacy and permission notes covering Codex CLI, OpenCode, model providers, local API keys, and vault write boundaries.
- Prepared release assets for community installation:
main.js,manifest.json,styles.css, andcodex-echoink-0.5.0.zip.
v0.4.1
New feature: Knowledge channel refinements for querying, visibility, and day-to-day control.
What changed:
- Added
/askfor read-only knowledge questions. It searcheswiki/first, sends the most relevant notes as context, and asks the Agent to distinguish Vault evidence from supplemental information. - Kept read-only Knowledge Q&A behind explicit
/ask; ordinary natural-language messages stay as normal Agent chat in current 0.5.2 behavior. - Upgraded the Knowledge health heatmap from a short recent strip to a full-year GitHub-style view with month labels, weekday labels, success states, and failed checks.
- Added Codex CLI model and reasoning-effort controls directly in the Knowledge channel composer. The Knowledge task no longer has to use a hard-coded reasoning level.
- Added search boxes to the current-vault
Plugins,MCP, andSkillscapability tabs. Search covers name, id/path, metadata, and description, and multiple words work as an AND filter. - Fixed long capability rows by clipping names, paths, and descriptions with ellipses, so the right-side checkbox remains visible and clickable.
- Kept
LLM-WIKI.mdas the default knowledge rules file, withAGENTS.mdpreserved as a compatibility option and runtime background.
How to use:
- Open the
Knowledgechannel. - Type
/ask your questionwhen you want the Knowledge channel to search vault sources. - Use the bottom model button in Codex CLI mode to choose the model and reasoning effort for Knowledge tasks.
- Expand the health dashboard to review the full-year check heatmap.
- Open plugin settings, go to current-vault capability management, then search within
Plugins,MCP, orSkillsbefore toggling items.
v0.4.0
New feature: Knowledge Base Operations for automated Obsidian vault maintenance.
What changed:
- Added a persistent knowledge base channel bound to the current vault.
- Added command templates:
/check,/maintain,/outputs,/journal, and/inbox. - Added WeChat, web page, and file capture entry points for Raw Sources.
- Added configurable knowledge base rules file.
LLM-WIKI.mdis the default; a custom Markdown file can replace it. - Added an optional
codex-memory-literecommendation in settings for users who want long-term memory across knowledge-base runs. - Added OpenCode model selection and OpenCode Agent selection for OpenCode API mode.
- Added selected-text translation to English from the editor context menu.
- Improved the knowledge base settings page alignment, status copy, and rules-file picker.
- Kept the safety boundary: existing Raw files are not rewritten, deleted, or archived automatically.
How to use:
- Open the
Knowledgechannel in the Codex sidebar. - In settings, choose
Codex CLIorOpenCode APIas the knowledge base backend. - For OpenCode mode, install OpenCode locally, then refresh and select a model and Agent.
- For a new vault, type
/initto preview the LLM Wiki setup; type/init confirmonly after reviewing it. - Use the pinned health dashboard to check rules, Raw/Wiki/Inbox counts, risk reasons, folder updates, and recent
/checkhistory. - Type
/check broken links,/maintain new raw sources, or/outputs weekly notesin the knowledge channel. - Use the capture shortcuts to collect WeChat articles, web pages, or files into Raw Sources.
v0.3.0
New feature: Writing Context Harness for editor rewrite, expand, and continue.
What changed:
- Added
Fast,Quality, andStrictwriting quality modes. - Added visible article understanding in the sidebar writing context panel.
- Added structured article understanding for theme, audience, purpose, structure, facts, style, fabrication boundaries, and local writing guidance.
- Added soft reuse for article understanding, so small continuous edits reuse existing understanding instead of re-running it every time.
- Added strict-mode review, which checks the generated candidate before showing it.
- Kept the inline candidate flow:
Enteraccepts,Esccancels. - Kept article understanding out of the normal chat history.
How to use:
- Enable writing actions in the plugin settings.
- Choose the default writing quality mode:
Fast,Quality, orStrict. - Select text in the editor and run
Rewrite,Expand, orContinue. - Click the
Writingchip in the sidebar to inspect or refresh article understanding. - Press
Enterto accept the gray candidate, orEscto cancel.
v0.2.0
Bug fix: fixed spawn codex ENOENT after Codex account re-login by detecting the Codex Desktop CLI path and adding a manual login refresh button.
Experimental feature: rewrite, expand, and continue selected editor text in place. This is still experimental, disabled by default, and not recommended for stable daily use.
How to test:
- Enable writing actions in the plugin settings.
- Select text in the editor and right-click
Rewrite,Expand, orContinue. - Press
Enterto accept the gray candidate, orEscto cancel. - Test on non-critical notes first.
v0.1.2
New feature: public releases now keep the GitHub repository focused on install and usage files only.
How to use:
- Download the latest release package.
- Install the
codex-echoinkplugin folder. - Use the plugin without browsing internal project documents.
v0.1.1
New feature: paste WeChat or system screenshots directly into the Codex input box.
How to use:
- Take a screenshot.
- Click the Codex input box.
- Press
Command+V, then send.
Install
- Install and log in to Codex CLI for Codex CLI mode.
- Optionally install OpenCode if you want to use OpenCode API mode for knowledge base management.
- Download
codex-echoink-0.5.2.zipfrom the latest release. - Unzip it and get the
codex-echoinkfolder. - Move it into your vault plugin directory:
<vault>/.obsidian/plugins/codex-echoink/
- Restart Obsidian and enable
Codex EchoInkin Community plugins.
The plugin folder should contain:
codex-echoink/
main.js
manifest.json
styles.css
Quick Start
- Open the Codex sidebar from the ribbon icon or command palette.
- Choose a folder as the workspace in an ordinary chat session.
- Ask Codex to inspect, summarize, rewrite, or manage files in that workspace.
- Attach notes, files, images, skills, or MCP tools when needed; attachments are context only.
- Review the process cards for commands, edits, context usage, and evidence.
- Open the
Knowledgechannel when you want Codex to operate your vault knowledge base. - For a new vault, start with
/init; for an existing structured vault, start with/check, then use/ask,/maintain, or/outputsdepending on whether you want an answer, a maintenance run, or structured knowledge output.
Troubleshooting
Windows WebSocket or os error 10061
If Codex CLI logs mention responses_websocket, wss://chatgpt.com/backend-api/codex/responses, actively refused, or os error 10061, the failure is usually in the Codex CLI ChatGPT-login WebSocket connection.
Try these steps:
- Set the plugin default model to
Auto, or choose a model other thangpt-5.5. - If your network requires a local proxy, enable the plugin proxy setting and enter a URL such as
http://127.0.0.1:7890. - Reconnect Codex from the settings page, or restart Obsidian.
- If it still fails, share the new detailed plugin error and the relevant Codex CLI log lines with account details removed.
Privacy and permissions
- Codex EchoInk is desktop-only because it calls local command-line tools.
- Codex CLI mode uses your local Codex CLI login and may send selected prompts, attachments, and chosen file context to the model provider configured in Codex.
- OpenCode API mode connects to a local or user-configured OpenCode server. The plugin can start or stop
opencode serve, but it does not silently install OpenCode. - Custom API provider keys are stored in Obsidian plugin data on your local machine. Use them only on a trusted device.
- The plugin does not upload your whole vault by default. Ordinary chat requires choosing a workspace folder, and attached notes are turn context only.
- Knowledge management runs keep Raw source bodies read-only and only update indexes or trackers. In ordinary Agent chat, Raw file organization follows your explicit instruction and the active permission mode.
Screenshots


Development
npm install
npm run test
npm run typecheck
npm run build
Generate a shareable install package:
npm run package
Deploy to your own Obsidian vault:
OBSIDIAN_VAULT=/path/to/your/vault npm run deploy
Requirements
- Codex CLI must be installed and available locally for Codex CLI mode.
- OpenCode must be installed locally for OpenCode API mode. The plugin can connect to or start the OpenCode server, but it does not silently install OpenCode.
- Custom API providers for Codex CLI mode must be compatible with the OpenAI Responses API, such as
/v1/responses. Providers that only support/v1/chat/completionsmay not work. - Custom API keys are stored in Obsidian plugin data, so use them only on a trusted local machine.
- Leave the Codex CLI path empty to auto-detect it from
PATHand common install folders, or set the path manually in plugin settings.
License
Codex EchoInk is open source under the MIT License.
You may use, copy, modify, merge, publish, distribute, sublicense, and sell copies of this software as permitted by the MIT License, as long as the copyright and license notice are included. The software is provided "as is", without warranty of any kind.