obsidian-catui-acp 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 cunyu666
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,52 @@
+# CatUI ACP for Obsidian
+
+Desktop plugin with compiled files and TypeScript/React source for chatting with a local CatUI agent through ACP. Includes streaming responses, tool activity, session controls, active note context, permission review, and diagnostics.
+
+## Install from npm
+
+This package is a distribution of an Obsidian plugin, not a Node.js library. Installing it with npm alone does not enable it in Obsidian.
+
+Download it from the public npm registry:
+
+```sh
+npm pack obsidian-catui-acp@0.1.0 --registry=https://registry.npmjs.org/
+```
+
+Extract the archive and copy **main.js**, **manifest.json**, and **styles.css** from its `package/` folder into `<your-vault>/.obsidian/plugins/catui-acp/`. Reload Obsidian and enable **CatUI ACP** under Community plugins. This package has no npm runtime dependencies and no automatic installation scripts.
+
+Alternatively, `npm install obsidian-catui-acp --registry=https://registry.npmjs.org/` downloads the same files to `node_modules/obsidian-catui-acp/`; copy the same three files from there.
+
+## Set up CatUI
+
+Install [CatUI](https://github.com/O-Pencil/Catui) separately with `npm install -g catui-agent --registry=https://registry.npmjs.org/` (Node.js 20+). Run `catui` to configure your model provider and credentials. In Obsidian plugin settings, set the command to `catui` (or its full executable path) and arguments to `--acp`. The executable and Node.js must be accessible to Obsidian's environment. The plugin does not install or update CatUI.
+
+Requires Obsidian desktop; mobile is unsupported. The manifest declares Obsidian 1.5.0 as its minimum, but cross-version and Windows compatibility have not been independently verified for this distribution.
+
+## Vault behavior
+
+This is the author's current **LLM-Wiki-oriented version**, not the unfinished generic release candidate. It adds instructions that `raw/` is immutable, `wiki/` is agent-maintained, `wiki/log.md` is append-only, and that the agent should follow the vault's AGENTS.md and LLM-Wiki skill. Raw-path permission filtering is enabled by default and can be disabled in settings. These instructions and permission filters are not a filesystem sandbox.
+
+## Privacy and permissions
+
+Prompts, the optional active note path, and selected text are sent to a local CatUI process over stdin/stdout. CatUI may read more files and send their contents and tool results to your configured model provider, such as OpenAI, Anthropic, Google, Alibaba DashScope, or local Ollama. Remote providers supply model inference and may require an account, API key, and payment; consult their data policies. The plugin itself has no subscription and stores no provider API keys.
+
+CatUI can access files outside the vault, including configuration, credentials, sessions, and memory under its home configuration directory. It runs with your OS permissions. Ask mode requests review for agent operations; bypass mode may execute without review. The raw-path filter only handles requests the agent actually sends to the plugin and does not guarantee protection against every tool or path.
+
+The plugin adds no telemetry; CatUI, extensions, and providers have their own policies. Markdown images can contact their hosts, and clicked links open external websites. Diagnostics may contain file paths or agent output. Personal plugin configuration is not included in this package.
+
+## License
+
+Plugin code: MIT. Bundled third-party notices are in `THIRD_PARTY_NOTICES.txt` and embedded in `main.js`. CatUI is separately distributed under GPL-3.0 and is not included. This is a community plugin, not an official Obsidian product.
+
+## Build from source
+
+Source, tests, and build configuration are included. After extracting the npm archive, enter its `package` directory and run:
+
+```sh
+npm install --include=dev --registry=https://registry.npmjs.org/
+npm run typecheck
+npm test
+npm run build
+```
+
+All build dependencies are development dependencies, so users downloading the plugin with `npm install obsidian-catui-acp` do not install the development toolchain. npm may omit `package-lock.json` from published packages; use the declared dependency ranges when building from the npm archive.