Getting Started

Mitii is a local-first AI coding agent. It reads your codebase, thinks before it acts, and only does what you allow, all on your own machine.

There are a few ways to use Mitii, depending on where you like to work. Pick the one that fits you:

I want to…	Use
Code inside my editor	VS Code Extension
Chat with Mitii in a standalone window	Desktop app
Work from the terminal	CLI
Build Mitii into my own app	SDK
Let Mitii work while I'm away	Automation

Before you start

• Node.js 20+ (22 recommended): needed for the CLI, SDK, and automation
• VS Code 1.124+: only if you're using the extension
• A model to talk to: either Ollama running locally (no API key needed) or a cloud provider like Anthropic, OpenAI, or Gemini

Install the VS Code Extension

This is the quickest way to get started: Mitii lives right inside your editor, next to your code.

1. Add the extension

   Install it from the VS Code Marketplace, or open the Extensions panel (Cmd+Shift+X / Ctrl+Shift+X), search for Mitii AI Agent, and click Install.

2. Open your project

   Open the folder you want to work on in VS Code.

3. Connect a model

   Click the Mitii icon in the activity bar, go to Settings → Provider, pick a preset, add your API key, hit Test connection, then Save.

4. Say hello

   Open the Mitii sidebar, wait for indexing to finish, and type what you'd like done. Tip: use @filename to point Mitii at a specific file.

More details: VS Code Extension Overview

Install the Desktop app

Prefer a dedicated window over an editor panel? The desktop app gives you chat, repository management, and git in one place: powered by the same engine as everything else.

1. Get the code

   git clone https://github.com/Mitii-dev/Mitii
   cd Mitii

2. Install and build

   pnpm install
   pnpm --filter @mitii/sdk --filter @mitii/host --filter @mitii/mcp build
   pnpm --filter @mitii/desktop build

3. Launch it

   pnpm --filter @mitii/desktop dev

4. Connect a model

   Open Settings in the app, pick a provider, and add your API key or run mitii setup once and the desktop app will pick up the same configuration.

More details: Desktop Overview and Desktop Setup

Install the CLI

The CLI is for people who live in the terminal. It's the same agent, just driven by commands.

1. Install Node.js

   Node.js 20+ (22 recommended).

2. Install the CLI

   npm install -g @mitii/cli

3. Set up your model

   mitii setup

   This walks you through picking a provider, entering your API key, and choosing a model.

4. Run it

   mitii session
   # or give it a task directly:
   mitii "your task"

More details: CLI Setup & Providers

Install the SDK

Building your own tool and want Mitii inside it? The SDK lets you embed the agent in any Node.js application.

1. Add the package

   npm install @mitii/sdk

2. Create an agent

   import { createAgent } from "@mitii/sdk";
   const agent = createAgent({ cwd: "/path/to/repo" });

3. Give it a task

   await agent.run("Refactor utils to named exports");

More details: SDK Reference

Set up automation

Want Mitii to keep working while you're away: running scheduled jobs, reacting to pushes or CI failures, opening draft PRs on its own? That's what the daemon is for.

1. Install the daemon

   npm install -g @mitii/daemon

2. Start it

   mitii-daemon --cwd /path/to/repo

3. Tell it what to do

   Drop a small agent spec into .mitii/cron/ or wire up a webhook and pick an autonomy preset (readonly, apply, apply_and_pr) to set the boundaries.

More details: Automation overview and Daemon docs

Next steps

• Configuration(every setting, explained)
• Connect a model(the full provider guide)
• Features(indexing, memory, skills, MCP, and more)
• Automation(cron jobs, event triggers, and shipped agents)
• Why Mitii?(the design philosophy behind it all)