# OSagent Documentation

> Local-first AI agent for your operating system. Made by Locai Labs.
> Runs entirely on your machine — no cloud, no API keys, no data leaves your computer.

Full text of every page is available at [https://docs.osagent.computer/llms-full.txt](https://docs.osagent.computer/llms-full.txt).

## Guide

- [CLI Reference](https://docs.osagent.computer/guide/cli-reference): osagent ships as a single binary. Run it with no arguments for an
- [Community](https://docs.osagent.computer/guide/community): Three places to talk to us and to other people building with OSagent.
- [Configuration](https://docs.osagent.computer/guide/configuration): All configuration lives in ~/.osagent/config.json. The first-run wizard
- [Windows & Linux Desktop](https://docs.osagent.computer/guide/desktop-tauri): The Tauri desktop app for Windows and Linux is planned for v0.2.0. Contributions are welcome!
- [Getting Started](https://docs.osagent.computer/guide/getting-started): The installer downloads the CLI, installs llama-server if missing, adds everything to your PATH, and launches the setup wizard.
- [macOS Desktop App](https://docs.osagent.computer/guide/macos-app): A native SwiftUI app with a floating overlay panel, system tray icon, and global hotkey.
- [Memory](https://docs.osagent.computer/guide/memory): OSagent stores persistent memory in ~/.osagent/memory/ as plain markdown files that you can read and edit with any text editor.
- [Providers](https://docs.osagent.computer/guide/providers): OSagent talks to anything that exposes the OpenAI Chat Completions wire
- [Roadmap](https://docs.osagent.computer/guide/roadmap): Where OSagent is heading. Dates are deliberately absent — this is a
- [Sandbox & Safety](https://docs.osagent.computer/guide/sandbox-and-safety): OSagent gives the model real tools — file I/O and shell execution — so a
- [Skills](https://docs.osagent.computer/guide/skills): Skills are reusable procedures the agent creates, updates, and follows. They live in ~/.osagent/skills/ as markdown files.
- [Tools](https://docs.osagent.computer/guide/tools): OSagent comes with a set of built-in tools that give the agent real capabilities on your machine.
- [Troubleshooting](https://docs.osagent.computer/guide/troubleshooting): A short list of things people hit early. If you run into something not
- [What is OSagent?](https://docs.osagent.computer/guide/what-is-osagent): OSagent is a local-first AI agent for your operating system, made by Locai Labs. It runs entirely on your machine by default — no cloud services, no API keys, no data leaves your computer — and you…

## Framework

- [Agent](https://docs.osagent.computer/framework/agent): The Agent class is the main entry point for the framework. It handles streaming, tool execution, context management, and multi-turn conversation.
- [Architecture](https://docs.osagent.computer/framework/architecture): A quick sketch of how the pieces fit together. Internals will change
- [Context & Compaction](https://docs.osagent.computer/framework/context-and-compaction): Long sessions overflow the model's context window. The agent summarises
- [Events](https://docs.osagent.computer/framework/events): AgentEventEmitter is a typed event bus for observability — session
- [Hooks](https://docs.osagent.computer/framework/hooks): Hooks run custom logic before or after every tool call, and at session and
- [Model Client](https://docs.osagent.computer/framework/model-client): The Agent supports a pluggable modelClient interface. This lets you keep the same tool loop while swapping transport or runtime — for example, an on-device React Native client, a custom proxy, or a…
- [Agent Framework Overview](https://docs.osagent.computer/framework/overview): The Agent Framework (@locailabs/agent-framework) is the core TypeScript library that powers OSagent. It works with most OpenAI-compatible LLM endpoints — llama.cpp, vLLM, Ollama, OpenAI, and others…
- [Skills (Framework)](https://docs.osagent.computer/framework/skills): The framework provides a SkillLoader class and makeReadSkillTool factory for integrating the skills system into your agent.
- [Streaming](https://docs.osagent.computer/framework/streaming): The agent emits real-time events via a streamingHandler callback. Use it
- [Tool Result Contract](https://docs.osagent.computer/framework/tool-result-contract): Built-in tools return strings in a small set of shapes so the model can
- [Tools](https://docs.osagent.computer/framework/tools): A **tool** is an async function paired with an OpenAI-compatible JSON schema.
- [Traces](https://docs.osagent.computer/framework/traces): OSagent records each user turn as a structured JSONL entry on disk.
- [User Tools](https://docs.osagent.computer/framework/user-tools): You can extend the agent with your own tools by dropping them into

## Other

- [Contributing](https://docs.osagent.computer/contributing): Thanks for your interest in contributing to OSagent.
- [OSagent](https://docs.osagent.computer/): The local-first AI agent for your operating system. Built by Locai Labs.