# Newroz Agent

> The self-improving AI agent. A terminal-native autonomous coding and task agent with persistent memory, agent-created skills, and a messaging gateway that lives on 21+ messaging platforms — 19 native to the gateway plus IRC and Microsoft Teams via plugins (Telegram, Discord, Slack, SMS, Matrix, ...). Runs on local, Docker, SSH, Daytona, Modal, or Singularity backends. Works with Nous Portal, OpenRouter, OpenAI, Anthropic, Google, or any OpenAI-compatible endpoint.

Install: `curl -fsSL https://raw.githubusercontent.com/NousResearch/newroz-agent/main/scripts/install.sh | bash`  (Linux, macOS, WSL2, Termux)

Repo: https://github.com/newroz-agent/newroz-agent

## Getting Started

- [Installation](https://newroz-agent.github.io/docs/getting-started/installation): Install Newroz Agent on Linux, macOS, WSL2, native Windows, or Android via Termux
- [Quickstart](https://newroz-agent.github.io/docs/getting-started/quickstart): Your first conversation with Newroz Agent — from install to chatting in under 5 minutes
- [Learning Path](https://newroz-agent.github.io/docs/getting-started/learning-path): Choose your learning path through the Newroz Agent documentation based on your experience level and goals.
- [Updating](https://newroz-agent.github.io/docs/getting-started/updating): How to update Newroz Agent to the latest version or uninstall it
- [Termux (Android)](https://newroz-agent.github.io/docs/getting-started/termux): Run Newroz Agent directly on an Android phone with Termux
- [Nix Setup](https://newroz-agent.github.io/docs/getting-started/nix-setup): Install and deploy Newroz Agent with Nix — from quick `nix run` to fully declarative NixOS module with container mode

## Using Newroz

- [CLI](https://newroz-agent.github.io/docs/user-guide/cli): Master the Newroz Agent terminal interface — commands, keybindings, personalities, and more
- [TUI (Ink terminal UI)](https://newroz-agent.github.io/docs/user-guide/tui): Launch the modern terminal UI for Newroz — mouse-friendly, rich overlays, and non-blocking input.
- [Configuration](https://newroz-agent.github.io/docs/user-guide/configuration): Configure Newroz Agent — config.yaml, providers, models, API keys, and more
- [Configuring Models](https://newroz-agent.github.io/docs/user-guide/configuring-models)
- [Sessions](https://newroz-agent.github.io/docs/user-guide/sessions): Session persistence, resume, search, management, and per-platform session tracking
- [Profiles](https://newroz-agent.github.io/docs/user-guide/profiles)
- [Git Worktrees](https://newroz-agent.github.io/docs/user-guide/git-worktrees): Run multiple Newroz agents safely on the same repository using git worktrees and isolated checkouts
- [Docker Backend](https://newroz-agent.github.io/docs/user-guide/docker): Running Newroz Agent in Docker and using Docker as a terminal backend
- [Security](https://newroz-agent.github.io/docs/user-guide/security): Security model, dangerous command approval, user authorization, container isolation, and production deployment best practices
- [Checkpoints & Rollback](https://newroz-agent.github.io/docs/user-guide/checkpoints-and-rollback): Filesystem safety nets for destructive operations using shadow git repos and automatic snapshots

## Core Features

- [Features Overview](https://newroz-agent.github.io/docs/user-guide/features/overview)
- [Tools](https://newroz-agent.github.io/docs/user-guide/features/tools): Overview of Newroz Agent's tools — what's available, how toolsets work, and terminal backends
- [Skills System](https://newroz-agent.github.io/docs/user-guide/features/skills): On-demand knowledge documents — progressive disclosure, agent-managed skills, and the Skills Hub
- [Curator](https://newroz-agent.github.io/docs/user-guide/features/curator): Background maintenance for agent-created skills — usage tracking, staleness, archival, and LLM-driven review
- [Memory](https://newroz-agent.github.io/docs/user-guide/features/memory): How Newroz Agent remembers across sessions — MEMORY.md, USER.md, and session search
- [Memory Providers](https://newroz-agent.github.io/docs/user-guide/features/memory-providers): External memory provider plugins — Honcho, OpenViking, Mem0, Hindsight, Holographic, RetainDB, ByteRover, Supermemory
- [Context Files](https://newroz-agent.github.io/docs/user-guide/features/context-files): Project context files — .newroz.md, AGENTS.md, CLAUDE.md, global SOUL.md, and .cursorrules — automatically injected into every conversation
- [Context References](https://newroz-agent.github.io/docs/user-guide/features/context-references): Inline @-syntax for attaching files, folders, git diffs, and URLs directly into your messages
- [Personality & SOUL.md](https://newroz-agent.github.io/docs/user-guide/features/personality): Customize Newroz Agent's personality with a global SOUL.md, built-in personalities, and custom persona definitions
- [Plugins](https://newroz-agent.github.io/docs/user-guide/features/plugins): Extend Newroz with custom tools, hooks, and integrations via the plugin system
- [Built-in Plugins](https://newroz-agent.github.io/docs/user-guide/features/built-in-plugins): Plugins shipped with Newroz Agent that run automatically via lifecycle hooks — disk-cleanup and friends

## Automation

- [Cron Jobs](https://newroz-agent.github.io/docs/user-guide/features/cron): Schedule automated tasks with natural language, manage them with one cron tool, and attach one or more skills
- [Delegation](https://newroz-agent.github.io/docs/user-guide/features/delegation): Spawn isolated child agents for parallel workstreams with delegate_task
- [Kanban Multi-Agent](https://newroz-agent.github.io/docs/user-guide/features/kanban): Durable SQLite-backed task board for coordinating multiple Newroz profiles
- [Kanban Tutorial](https://newroz-agent.github.io/docs/user-guide/features/kanban-tutorial)
- [Persistent Goals](https://newroz-agent.github.io/docs/user-guide/features/goals): Set a standing goal and let Newroz keep working across turns until it's done. Our take on the Ralph loop.
- [Code Execution](https://newroz-agent.github.io/docs/user-guide/features/code-execution): Programmatic Python execution with RPC tool access — collapse multi-step workflows into a single turn
- [Hooks](https://newroz-agent.github.io/docs/user-guide/features/hooks): Run custom code at key lifecycle points — log activity, send alerts, post to webhooks
- [Batch Processing](https://newroz-agent.github.io/docs/user-guide/features/batch-processing): Generate agent trajectories at scale — parallel processing, checkpointing, and toolset distributions

## Media & Web

- [Voice Mode](https://newroz-agent.github.io/docs/user-guide/features/voice-mode): Real-time voice conversations with Newroz Agent — CLI, Telegram, Discord (DMs, text channels, and voice channels)
- [Browser](https://newroz-agent.github.io/docs/user-guide/features/browser)
- [Vision](https://newroz-agent.github.io/docs/user-guide/features/vision)
- [Image Generation](https://newroz-agent.github.io/docs/user-guide/features/image-generation)
- [Text-to-Speech](https://newroz-agent.github.io/docs/user-guide/features/tts): Text-to-speech and voice message transcription across all platforms

## Messaging Platforms

- [Overview](https://newroz-agent.github.io/docs/user-guide/messaging/index): Chat with Newroz from Telegram, Discord, Slack, WhatsApp, Signal, SMS, Email, Home Assistant, Mattermost, Matrix, DingTalk, Yuanbao, Microsoft Teams, LINE, Raft, Webhooks, or any OpenAI-compatible frontend via the API server — architecture and setup overview
- [Telegram](https://newroz-agent.github.io/docs/user-guide/messaging/telegram): Set up Newroz Agent as a Telegram bot
- [Discord](https://newroz-agent.github.io/docs/user-guide/messaging/discord): Set up Newroz Agent as a Discord bot
- [Slack](https://newroz-agent.github.io/docs/user-guide/messaging/slack): Set up Newroz Agent as a Slack bot using Socket Mode
- [WhatsApp](https://newroz-agent.github.io/docs/user-guide/messaging/whatsapp): Set up Newroz Agent as a WhatsApp bot via the built-in Baileys bridge
- [Signal](https://newroz-agent.github.io/docs/user-guide/messaging/signal): Set up Newroz Agent as a Signal messenger bot via signal-cli daemon
- [Email](https://newroz-agent.github.io/docs/user-guide/messaging/email): Set up Newroz Agent as an email assistant via IMAP/SMTP
- [SMS](https://newroz-agent.github.io/docs/user-guide/messaging/sms): Set up Newroz Agent as an SMS chatbot via Twilio
- [Matrix](https://newroz-agent.github.io/docs/user-guide/messaging/matrix): Set up Newroz Agent as a Matrix bot
- [Mattermost](https://newroz-agent.github.io/docs/user-guide/messaging/mattermost): Set up Newroz Agent as a Mattermost bot
- [Home Assistant](https://newroz-agent.github.io/docs/user-guide/messaging/homeassistant)
- [Webhooks](https://newroz-agent.github.io/docs/user-guide/messaging/webhooks): Receive events from GitHub, GitLab, and other services to trigger Newroz agent runs

## Integrations

- [Integrations Overview](https://newroz-agent.github.io/docs/integrations/index)
- [Providers](https://newroz-agent.github.io/docs/integrations/providers)
- [MCP (Model Context Protocol)](https://newroz-agent.github.io/docs/user-guide/features/mcp): Connect Newroz Agent to external tool servers via MCP — and control exactly which MCP tools Newroz loads
- [ACP (Agent Context Protocol)](https://newroz-agent.github.io/docs/user-guide/features/acp): Use Newroz Agent inside ACP-compatible editors such as VS Code, Zed, and JetBrains
- [API Server](https://newroz-agent.github.io/docs/user-guide/features/api-server): Expose newroz-agent as an OpenAI-compatible API for any frontend
- [Honcho Memory](https://newroz-agent.github.io/docs/user-guide/features/honcho): AI-native persistent memory via Honcho — dialectic reasoning, multi-agent user modeling, and deep personalization
- [Provider Routing](https://newroz-agent.github.io/docs/user-guide/features/provider-routing)
- [Fallback Providers](https://newroz-agent.github.io/docs/user-guide/features/fallback-providers)
- [Credential Pools](https://newroz-agent.github.io/docs/user-guide/features/credential-pools)

## Guides & Tutorials

- [Tips & Best Practices](https://newroz-agent.github.io/docs/guides/tips): Practical advice to get the most out of Newroz Agent — prompt tips, CLI shortcuts, context files, memory, cost optimization, and security
- [Local LLMs on Mac](https://newroz-agent.github.io/docs/guides/local-llm-on-mac): Set up a local OpenAI-compatible LLM server on macOS with llama.cpp or MLX, including model selection, memory optimization, and real benchmarks on Apple Silicon
- [Daily Briefing Bot](https://newroz-agent.github.io/docs/guides/daily-briefing-bot): Build an automated daily briefing bot that researches topics, summarizes findings, and delivers them to Telegram or Discord every morning
- [Team Telegram Assistant](https://newroz-agent.github.io/docs/guides/team-telegram-assistant): Step-by-step guide to setting up a Telegram bot that your whole team can use for code help, research, system admin, and more
- [Use Newroz as a Python Library](https://newroz-agent.github.io/docs/guides/python-library): Embed AIAgent in your own Python scripts, web apps, or automation pipelines — no CLI required
- [Use MCP with Newroz](https://newroz-agent.github.io/docs/guides/use-mcp-with-newroz): A practical guide to connecting MCP servers to Newroz Agent, filtering their tools, and using them safely in real workflows
- [Use Voice Mode with Newroz](https://newroz-agent.github.io/docs/guides/use-voice-mode-with-newroz): A practical guide to setting up and using Newroz voice mode across CLI, Telegram, Discord, and Discord voice channels
- [Use SOUL.md with Newroz](https://newroz-agent.github.io/docs/guides/use-soul-with-newroz): How to use SOUL.md to shape Newroz Agent's default voice, what belongs there, and how it differs from AGENTS.md and /personality
- [Build a Newroz Plugin](https://newroz-agent.github.io/docs/guides/build-a-newroz-plugin)
- [Automate with Cron](https://newroz-agent.github.io/docs/guides/automate-with-cron): Real-world automation patterns using Newroz cron — monitoring, reports, pipelines, and multi-skill workflows
- [Work with Skills](https://newroz-agent.github.io/docs/guides/work-with-skills): Find, install, use, and create skills — on-demand knowledge that teaches Newroz new workflows
- [Delegation Patterns](https://newroz-agent.github.io/docs/guides/delegation-patterns): When and how to use subagent delegation — patterns for parallel research, code review, and multi-file work
- [GitHub PR Review Agent](https://newroz-agent.github.io/docs/guides/github-pr-review-agent): Build an automated AI code reviewer that monitors your repos, reviews pull requests, and delivers feedback — hands-free

## Developer Guide

- [Contributing](https://newroz-agent.github.io/docs/developer-guide/contributing): How to contribute to Newroz Agent — dev setup, code style, PR process
- [Architecture](https://newroz-agent.github.io/docs/developer-guide/architecture): Newroz Agent internals — major subsystems, execution paths, data flow, and where to read next
- [Agent Loop](https://newroz-agent.github.io/docs/developer-guide/agent-loop): Detailed walkthrough of AIAgent execution, API modes, tools, callbacks, and fallback behavior
- [Prompt Assembly](https://newroz-agent.github.io/docs/developer-guide/prompt-assembly): How Newroz builds the system prompt, preserves cache stability, and injects ephemeral layers
- [Context Compression & Caching](https://newroz-agent.github.io/docs/developer-guide/context-compression-and-caching)
- [Gateway Internals](https://newroz-agent.github.io/docs/developer-guide/gateway-internals): How the messaging gateway boots, authorizes users, routes sessions, and delivers messages
- [Session Storage](https://newroz-agent.github.io/docs/developer-guide/session-storage)
- [Provider Runtime](https://newroz-agent.github.io/docs/developer-guide/provider-runtime): How Newroz resolves providers, credentials, API modes, and auxiliary models at runtime
- [Adding Tools](https://newroz-agent.github.io/docs/developer-guide/adding-tools): How to add a new tool to Newroz Agent — schemas, handlers, registration, and toolsets
- [Adding Providers](https://newroz-agent.github.io/docs/developer-guide/adding-providers): How to add a new inference provider to Newroz Agent — auth, runtime resolution, CLI flows, adapters, tests, and docs
- [Adding Platform Adapters](https://newroz-agent.github.io/docs/developer-guide/adding-platform-adapters)
- [Creating Skills](https://newroz-agent.github.io/docs/developer-guide/creating-skills): How to create skills for Newroz Agent — SKILL.md format, guidelines, and publishing
- [Extending the CLI](https://newroz-agent.github.io/docs/developer-guide/extending-the-cli): Build wrapper CLIs that extend the Newroz TUI with custom widgets, keybindings, and layout changes

## Reference

- [CLI Commands](https://newroz-agent.github.io/docs/reference/cli-commands): Authoritative reference for Newroz terminal commands and command families
- [Slash Commands](https://newroz-agent.github.io/docs/reference/slash-commands): Complete reference for interactive CLI and messaging slash commands
- [Profile Commands](https://newroz-agent.github.io/docs/reference/profile-commands)
- [Environment Variables](https://newroz-agent.github.io/docs/reference/environment-variables): Complete reference of all environment variables used by Newroz Agent
- [Tools Reference](https://newroz-agent.github.io/docs/reference/tools-reference): Authoritative reference for Newroz built-in tools, grouped by toolset
- [Toolsets Reference](https://newroz-agent.github.io/docs/reference/toolsets-reference): Reference for Newroz core, composite, platform, and dynamic toolsets
- [MCP Config Reference](https://newroz-agent.github.io/docs/reference/mcp-config-reference): Reference for Newroz Agent MCP configuration keys, filtering semantics, and utility-tool policy
- [Model Catalog](https://newroz-agent.github.io/docs/reference/model-catalog)
- [Bundled Skills Catalog](https://newroz-agent.github.io/docs/reference/skills-catalog): Table of all ~90 skills bundled with Newroz
- [Optional Skills Catalog](https://newroz-agent.github.io/docs/reference/optional-skills-catalog): Table of ~60 additional installable skills
- [FAQ & Troubleshooting](https://newroz-agent.github.io/docs/reference/faq): Frequently asked questions and solutions to common issues with Newroz Agent