Misar IO Docs

Installation

Install Misar Code from the VS Code Marketplace or via local VSIX, then configure your first settings.

Installation

Misar Code is available through two installation methods: the VS Code Marketplace for the easiest setup, or a local VSIX file if you are working offline or want to pin a specific version.

VS Code Marketplace

In VS Code, press Cmd+Shift+X (macOS) or Ctrl+Shift+X (Windows/Linux) to open the Extensions panel.

Type Misar Code in the search box. Look for the extension published by Misar AI.

Click Install. VS Code downloads and activates the extension automatically. No reload required.

Local VSIX (Offline or Pinned Version)

If you have the source repository cloned, you can build and install the extension locally.

cd vscode-extension
npm run deploy:local

This command:

  1. Compiles the TypeScript extension source
  2. Packages it into a .vsix file (misarcoder-local.vsix)
  3. Installs it with code --install-extension misarcoder-local.vsix --force

After installation, reload VS Code:

Cmd+Shift+P → Reload Window

The local install workflow is also the recommended approach during active development. Run npm run deploy:local after any changes to pick them up immediately.

First-Run Setup

When Misar Code activates in a workspace for the first time, it runs an automatic project analysis:

  1. Project scan — detects language, framework, package manager, directory structure, and coding conventions
  2. MISAR.md generation — writes .misar/MISAR.md with project-specific context that the agent loads on every session
  3. Hook directories — creates .misar/hooks/ with empty placeholder scripts for session-start, pre-tool-use, and post-tool-use

You can edit .misar/MISAR.md immediately after generation to add custom rules, preferred patterns, or constraints for the agent.

Settings Reference

Configure Misar Code in VS Code settings (Cmd+, → search "misar"):

| Setting | Type | Description | |---------|------|-------------| | misar.apiKey | string | Your Misar API key (from dashboard → API Keys) | | misar.apiBaseUrl | string | API base URL. Default: https://api.misar.dev | | misar.autoAcceptChanges | boolean | Auto-apply file edits without confirmation | | misar.showDetailedProgress | boolean | Show per-tool progress in the sidebar | | misarCode.codeLens | boolean | Show CodeLens actions above functions and classes | | misar.inlineCompletions | boolean | Enable inline code completions as you type | | misar.persona | string | Active AI persona (see Configuration) | | misar.systemPrompt | string | Custom system prompt appended to all requests | | misarCode.inlineEditMode | string | diff (preview before apply) or direct (apply immediately) | | misarCode.restoreSessionHours | number | Hours of history to restore on session resume | | misarCode.autoContext | boolean | Automatically include open files in agent context |

Keep your API key out of version control. Set it through the VS Code settings UI or the MISAR_API_KEY environment variable — never hard-code it in a project file.

Verify Installation

Open the Misar Code sidebar (Cmd+K Cmd+I) and type a message. If the agent responds, installation is complete. If you see a connection error, check that your API key is set correctly under misar.apiKey.