README file from
GithubSidebar MiMo-Code
Sidebar MiMo-Code embeds the MiMo-Code CLI agent in an Obsidian sidebar. The active vault is the agent working directory, so MiMo-Code can read, write, search, and run approved commands against vault content.
Features
- Sidebar chat with streaming, cancellation, resume, and native MiMo-Code history reload
- Native Build and Plan modes with custom MiMo-Code permission rules
- Inline editing with a diff preview
- Image attachments, instruction mode (
#), slash commands, skills, and custom subagents - Multiple chat tabs and automatic conversation titles
Forking and in-app MCP management are not currently supported. MCP server mentions are therefore not exposed in MiMo-Code chats.
Requirements
- Obsidian Desktop 1.7.2 or newer
- MiMo-Code CLI 0.1.1 (
npm install -g @mimo-ai/cli) - API credentials configured for the model provider used by MiMo-Code
Installation
GitHub release
- Download
main.js,manifest.json, andstyles.cssfrom the release. - Create
<your-vault>/.obsidian/plugins/sidebar-mimocode/. - Copy the three files into that directory.
- Enable Sidebar MiMo-Code under Obsidian → Settings → Community plugins.
From source
git clone https://github.com/AllenX95/sidebar-mimocode.git
cd sidebar-mimocode
npm ci
npm run build
Copy main.js, manifest.json, and styles.css to <your-vault>/.obsidian/plugins/sidebar-mimocode/.
Configuration
- Run MiMo-Code once and configure its model provider credentials.
- Open Obsidian → Settings → Sidebar MiMo-Code.
- Enable MiMo-Code and confirm the detected
mimoexecutable.
Custom permission rules can be added under Settings ? Sidebar MiMo-Code ? MiMo-Code ? Permissions. They use MiMo-Code's native permission format; later matching patterns take precedence:
{
"bash": {
"*": "ask",
"git status*": "allow"
},
"edit": "ask"
}
Custom subagents created by the plugin are stored under .mimocode/agent/. MiMo-Code data is read from its platform data directory, or from MIMOCODE_DB when configured.
Development
npm ci
npm run typecheck
npm run lint
npm run test
npm run build
Set OBSIDIAN_VAULT in .env.local to copy development builds to .obsidian/plugins/sidebar-mimocode/.
License
MIT.