Skip to content
550W-HOSTPublic

About

No description, website, or topics provided.

Resources

Stars

8 stars

Watchers

0 watching

Forks

Repository files navigation

Foxwarm 🦊

Foxwarm is a self-hosted TypeScript runtime for AI agents. It combines persistent conversations, Agent memory, tool calling, and a WebUI with optional messaging Channels and execution Nodes.

Website · Documentation

What you can do

  • Work with agents in the WebUI, with chat, files, code, and terminals in one place.
  • Give each Agent its own workspace, memory, and Skills, and use separate Sessions for different tasks.
  • Keep long conversations usable with layered context compaction and recall. Semantic history search is optional.
  • Run file and shell tools locally or on configured Nodes, and connect tools through MCP.
  • Use OpenAI-compatible or Anthropic model providers, including local gateways.

Get started

Install Git and Node.js 20+ with npm. Linux, macOS, and WSL also need tmux.

Linux, macOS, or WSL

curl -fsSL https://foxwarm.550w.host/install-foxwarm.sh | bash

Windows PowerShell

irm https://foxwarm.550w.host/install-foxwarm.ps1 | iex

The installer creates ./foxwarm for the program and ./foxwarm-data for runtime data, builds the app, and starts it. Open the WebUI URL printed by the installer and configure your provider in Setup → Models to start chatting.

See the installation guide for prerequisites, custom paths, manual installation, and startup commands. The installer scripts are available to inspect: Bash and PowerShell.

Keep access tokens private. Back up the whole data directory; see data, upgrades, and backups.

Agents, Sessions, and Nodes

An Agent holds a workspace, long-term memory, and instructions. A Session is a conversation bound to an Agent; one Agent can have several Sessions and create child Sessions for parallel work. Skills provide reusable instructions, and tools perform actions such as reading files or running commands.

A Node is an execution environment for tools. Use the local Node, pair a remote Node, or configure a supported provider. Tool access is controlled by authorization rules; granting shell access lets the agent run commands in that environment.

Read more about Agents and Sessions, tools and Skills, and Nodes.

Channels

Connect messaging platforms such as Telegram, Matrix, WeWork, Weixin, or QQ Bot to Foxwarm Sessions. Configure credentials and allowed users in Setup → Config; saving refreshes managed Channels.

See the Channels guide for setup and access controls.

Documentation

Start with the documentation site for installation, model setup, everyday use, and administration.

Development

To build from source:

git clone https://github.com/550W-HOST/foxwarm.git foxwarm
cd foxwarm
npm run build-all
npm run start:notmux

See the development guide and local test guide for the workflow and test commands. The repository's Code Index maps the implementation and records design decisions. Read the relevant entries before changing source, update them with affected behavior, and run npm run quality:code-index.

License

MIT

About

No description, website, or topics provided.

Resources

Stars

8 stars

Watchers

0 watching

Forks

Releases

Packages

Used by

Contributors

Languages