Elyra Documentation
Elyra is a terminal-first AI coding agent. Seven built-in tools, a growing extension ecosystem, and a core that stays out of your way. Set a goal and walk away. Rewind when things go wrong. Ask side questions without losing context.
Quick start
Install Elyra with npm:
npm install -g @elyracode/coding-agent
Then run it in a project directory:
elyra
Authenticate with /login for subscription providers, or set an API key such as ANTHROPIC_API_KEY before starting elyra.
For the full first-run flow, see Quickstart.
Start here
- Quickstart - install, authenticate, and run a first session.
- Using Elyra - interactive mode, slash commands, context files, and CLI reference.
- Providers - subscription and API-key setup for built-in providers.
- Settings - global and project settings.
- Keybindings - default shortcuts and custom keybindings.
- Sessions - session management, branching, tree navigation,
/rewind, and/goal. - Compaction - context compaction and branch summarization.
Customization
- Extensions - TypeScript modules for tools, commands, events, and custom UI.
- Skills - Agent Skills for reusable on-demand capabilities.
- Prompt templates - reusable prompts that expand from slash commands.
- Themes - built-in and custom terminal themes.
- Elyra packages - bundle and share extensions, skills, prompts, and themes.
- Custom models - add model entries for supported provider APIs.
- Custom providers - implement custom APIs and OAuth flows.
Programmatic usage
- SDK - embed elyra in Node.js applications.
- RPC mode - integrate over stdin/stdout JSONL.
- JSON event stream mode - print mode with structured events.
- TUI components - build custom terminal UI for extensions.
Reference
- Session format - JSONL session file format, entry types, and SessionManager API.
Platform setup
Development
- Development - local setup, project structure, and debugging.