README file from
GithubClaudian Mobile
A minimal AI writing and knowledge agent for your Obsidian vault. It calls the Anthropic Messages API directly from the client, so it works on Obsidian mobile (Android/iOS) as well as on desktop — no Node.js, no local CLI, no companion server.
Features
- Chat panel in the right sidebar, with streaming replies.
- The agent can act on your vault through a small set of tools:
read_note— read a note's contentwrite_note— replace a note's full contentpatch_note— apply a targeted edit to part of a notecreate_note— create a new notesearch_vault— full-text search across the vaultlist_files— list files and folders
- Tool calls are rendered inline, and edits are shown as a diff before they land.
- Model and reasoning effort can be switched from the composer, without opening settings.
- Interface available in English and Simplified Chinese; by default it follows Obsidian's own language.
- All paths are normalized and confined to the vault; the plugin cannot read or write outside it.
- Works with any endpoint that implements the Anthropic
/v1/messagesstreaming API, so you can point it at a proxy or a compatible third-party gateway.
Requirements and network use
This plugin requires an account with a third-party AI provider:
- By default it sends your prompts, and the content of the notes the agent reads or edits, to the Anthropic API (
https://api.anthropic.com) using an API key you supply. See Anthropic's privacy policy and terms. - If you change Base URL in the settings, requests go to that endpoint instead. Whatever you point it at receives the same data.
- No other network requests are made. There is no telemetry.
- Usage of the API is billed to your own account by your provider.
Your API key is stored in plaintext in .obsidian/plugins/claudian-mobile/data.json inside your vault. If your vault is synced or shared, the key travels with it — use a key you are comfortable having on every device that syncs the vault.
Setup
- Install the plugin (see below) and enable it.
- Open Settings → Claudian Mobile and paste your Anthropic API key (
sk-ant-...). You can create one at console.anthropic.com. - Optionally adjust the interface language, model, model list, reasoning effort, base URL, output token limit, tool-iteration cap, and system prompt.
- Open the chat with the ribbon icon (bot) or the Claudian Mobile: Open chat command.
Installation
From the community plugin list
Not yet available — this plugin is pending review.
Manual installation
- Download
main.js,manifest.json, andstyles.cssfrom the latest release. - Put them in
<your vault>/.obsidian/plugins/claudian-mobile/. - Reload Obsidian and enable the plugin under Settings → Community plugins.
Via BRAT
Install BRAT and add the beta plugin Charlesxiaomi/claudian-mobile.
Development
npm install
npm run dev # watch build
npm run build # production build
npm test # jest unit tests
npm run typecheck
npm run lint
Set OBSIDIAN_VAULT=/path/to/vault to have the build copy main.js, manifest.json, and styles.css straight into that vault's plugin folder.
Releasing
Releases are built by GitHub Actions; the trigger is a version tag.
npm version patch # or minor / major
git push --follow-tags
npm version bumps package.json, then a version hook syncs manifest.json
and adds the new entry to versions.json, so all three land in the version
commit that npm tags. Tags are bare version numbers (0.2.0, no v prefix) —
that is what Obsidian's installer and BRAT expect.
Pushing the tag runs .github/workflows/release.yml:
it typechecks, lints, tests, builds, verifies the tag matches manifest.json,
and publishes a release with main.js, manifest.json, and styles.css
attached. Those build outputs are deliberately not committed to the repo — a
release is the only place they are published, so cloning the repo alone is not
enough to run the plugin.