*magenta.txt*            Agentic AI coding assistant          *magenta.nvim*

                            MAGENTA.NVIM
                   Transparent tools for AI workflows

==============================================================================
CONTENTS                                                    *magenta-contents*

    1. Introduction ............................ |magenta-introduction|
    2. Requirements ............................ |magenta-requirements|
    3. Installation ............................ |magenta-installation|
    4. Quick Start ............................. |magenta-quickstart|

For detailed configuration options, see |magenta-config.txt|
For commands and keymaps, see |magenta-commands-keymaps.txt|
For tools and MCP support, see |magenta-tools.txt|
For provider configuration, see |magenta-providers.txt|
For the Edit Description Language, see |magenta-edl.txt|
For sub-agent types and workflows, see |magenta-subagents.txt|
For dev containers, see |magenta-docker.txt|
For the security model, see |magenta-security.txt|
For sandbox permissions, see |magenta-permissions.txt|
For creating skills, see |magenta-skills.txt|


==============================================================================
INTRODUCTION                                            *magenta-introduction*

Magenta.nvim provides transparent tools to empower AI workflows in Neovim.
It allows fluid shifting of control between the developer and the AI, from
AI automation and agent-led feature planning and development.
Features:~
  - Chat sidebar with multi-threading support
  - Sub-agents for parallel task processing
  - Web search with citations
  - MCP (Model Context Protocol) support
  - Smart context tracking with automatic diffing
  - Auto-compaction with chunked incremental summarization
  - Prompt caching for efficiency  - Dev containers for isolated Docker-based agent work

==============================================================================
REQUIREMENTS                                            *magenta-requirements*

- Neovim >= 0.8.0
- Node.js >= v20 (check with `node --version`)
- nvim-cmp (for input command completions)

Recommended tools:~
  - fd (sharkdp/fd) - Fast file finding that respects .gitignore
  - ripgrep (rg) - Fast text search that respects .gitignore

Without these tools, Magenta falls back to using `find`, which doesn't
respect `.gitignore` files.

==============================================================================
INSTALLATION                                            *magenta-installation*

Using lazy.nvim:~
>lua
    {
        "dlants/magenta.nvim",
        lazy = false,
        build = "npm run build",
        opts = {},
    }
<

Using vim-plug:~
>lua
    local vim = vim
    local Plug = vim.fn['plug#']

    vim.call('plug#begin')
    Plug('dlants/magenta.nvim', {
      ['do'] = 'npm run build',
    })
    vim.call('plug#end')

    require('magenta').setup({})
<

==============================================================================
QUICK START                                               *magenta-quickstart*

1. Set your API key environment variable:
>bash
    export ANTHROPIC_API_KEY="your-key-here"
<

2. Configure a profile in your setup (see |magenta-profiles|)

3. Open Neovim and use `<leader>mt` to toggle the sidebar

See |magenta-commands-keymaps| for the full list of commands and keymaps.

==============================================================================
DEVELOPMENT                                              *magenta-development*

The install hooks above run `npm run build` to produce a single-file bundle
at `dist/magenta.mjs`. Neovim invokes this bundle directly, which keeps
startup fast by avoiding thousands of file opens through the TypeScript
source tree.

When hacking on the plugin, set `MAGENTA_DEV=1` in your shell (or your
neovim launcher) to skip the bundle and run the TypeScript source directly
via `node --experimental-transform-types`:
>sh
    MAGENTA_DEV=1 nvim
<
If `dist/magenta.mjs` is missing (e.g. you cloned the repo without running
the build), the plugin automatically falls back to source mode and prints a
one-line warning.


vim:tw=78:ts=8:noet:ft=help:norl:
