Skip to content

# Documentation

Everything you need to install, configure, and get the most out of Swival.

## Basics

- Getting Started Installation, first run, what happens under the hood
- Usage One-shot mode, REPL mode, CLI flags, piping, exit codes
- Tools File ops, search, editing, web fetching, thinking, command execution
- Security Audit Multi-phase security audit with triage, verification, and patch generation
- Goals Persistent goal mode that keeps the agent on task across turns until the objective is done
- Context Management How Swival fits large tasks into small context windows
- Not Just for Frontier Models Why Swival is built to work well with small and open models too

## Configuration & Deployment

- Safety & Sandboxing Path resolution, symlink protection, command whitelisting
- Secret Encryption Format-preserving encryption of credentials before they reach the LLM provider
- Outbound LLM Filter User-defined scripts that redact or block content before it reaches the LLM provider
- Command Middleware Intercept, rewrite, or block shell commands before execution — RTK integration included
- Skills Creating and using SKILL.md-based agent skills
- The Library Staging downloaded skill collections and promoting them into projects
- Metaskills Portable standard for dynamic SKILL.md workflow programs
- Web Browsing Chrome DevTools MCP, agent-browser, and Lightpanda
- MCP Connecting external tool servers via Model Context Protocol
- A2A Connecting to remote agents via the Agent-to-Agent protocol
- ACP Driving Swival from ACP-aware editors like Zed and agent-client-protocol.nvim
- Lifecycle Hooks Run commands at startup and exit to sync .swival/ state with remote storage
- Custom Commands Run external scripts from the REPL and inject their output into the conversation
- Customization Config files, project instructions, system prompt overrides, tuning parameters
- Providers LM Studio, HuggingFace, OpenRouter, Google Gemini, Gemini Enterprise Agent Platform (Vertex AI), ChatGPT Plus/Pro, AWS Bedrock, and generic server configuration
- Reports JSON reports for benchmarking and evaluation
- Reviews External reviewer scripts for automated QA gates
- AgentFS Copy-on-write filesystem sandboxing
- nono Capability-based OS sandboxing with Landlock/Seatbelt, network filtering, and rollback

## Reference

- Python API Session, Result, run(), and the exception contract