DOCUMENTATION

Metis Documentation

RCv1.1.0-rc.1

Guides and references for using, configuring, extending, and embedding Metis.

Quick start

Requires Node.js >=22.19.0. Install the rc release from npm:

$ npm i -g @wholiver_hu/metis@rc

Start Metis inside the project you want it to understand:

$ cd /path/to/project
$ metis

Use /login for subscription providers, or configure an API key before launching. Then type a request and press Enter.

TIP

Add an AGENTS.md file to give Metis project-specific instructions, constraints, and verification commands.

Start here

QuickstartInstall, authenticate, and run your first useful session.Using MetisInteractive mode, commands, context files, and CLI reference.ProvidersSubscription login, API keys, and supported model providers.SecurityProject trust, local permissions, and external isolation guidance.ContainerizationIsolate Metis with Gondolin, Docker, or OpenShell.SettingsGlobal and project configuration.KeybindingsDefault shortcuts and custom keybindings.SessionsResume, branch, fork, clone, and navigate session trees.CompactionContext compaction and branch summarization.

Reliability

Memory & LessonsReuse decisions, project knowledge, and hard-won technical lessons.DreamConsolidate completed work into durable, structured experience.Search before actionInvestigate repositories and authoritative sources before editing.Logs & verificationPreserve task state and prove completion against requirements.

Customization

ExtensionsTypeScript modules for tools, commands, events, and custom UI.SkillsReusable on-demand capabilities with progressive disclosure.Prompt templatesReusable prompts expanded from slash commands.ThemesBuilt-in themes, tokens, and custom terminal styling.Metis packagesBundle and share extensions, skills, prompts, and themes.Custom modelsAdd model entries for supported provider APIs.Custom providersImplement custom APIs and OAuth flows.

Programmatic usage

SDKEmbed Metis in Node.js applications.RPC modeIntegrate over a stdin/stdout JSONL protocol.JSON event streamRun print mode with structured events.TUI componentsBuild terminal interfaces for extensions.

Reference

Session formatJSONL entries, trees, metadata, and SessionManager behavior.

Platform setup

WindowsConfigure the shell executable used on Windows.Termux on AndroidRun Metis in Termux.tmuxRecommended configuration and key behavior.Terminal setupColors, key protocols, and terminal compatibility.Shell aliasesUseful shell integrations and aliases.

Development

Development guideLocal setup, project structure, builds, and debugging.ContributingRepository contribution guidance and required checks.

Next stepSTART HEREQuick start→