Skip to main content

A small, powerful CLI coding agent for open AI models

Project description

Swival Logo

Swival

A coding agent for any model. Documentation

Swival is a CLI coding agent built to be practical, reliable, and easy to use. It works with frontier models, but its main goal is to be as reliable as possible with smaller models, including local ones. It is designed from the ground up to handle tight context windows and limited resources without falling apart.

It connects to LM Studio, HuggingFace Inference API, OpenRouter, Google Gemini, ChatGPT Plus/Pro, or any OpenAI-compatible server (ollama, llama.cpp, mlx_lm.server, vLLM, etc.), sends your task, and runs an autonomous tool loop until it produces an answer. With LM Studio it auto-discovers your loaded model, so there's nothing to configure. A few thousand lines of Python, no framework.

Quickstart

Pick the provider that matches how you want to run models:

Provider Auth Required flags First command
LM Studio none none swival "Refactor src/api.py"
HuggingFace HF_TOKEN or --api-key --provider huggingface --model ORG/MODEL swival --provider huggingface --model zai-org/GLM-5 "task"
OpenRouter OPENROUTER_API_KEY or --api-key --provider openrouter --model MODEL swival --provider openrouter --model z-ai/glm-5 "task"
Google Gemini GEMINI_API_KEY, OPENAI_API_KEY, or --api-key --provider google --model MODEL swival --provider google --model gemini-2.5-flash "task"
ChatGPT Plus/Pro browser auth on first run or CHATGPT_API_KEY --provider chatgpt --model MODEL swival --provider chatgpt --model gpt-5.4 "task"
Generic optional OPENAI_API_KEY --provider generic --base-url URL --model MODEL swival --provider generic --base-url http://127.0.0.1:8080 --model my-model "task"

Run swival --help for the grouped CLI reference and copy-paste examples.

LM Studio

  1. Install LM Studio and load a model with tool-calling support. Recommended first model: qwen3-coder-next (great quality/speed tradeoff on local hardware). Crank the context size as high as your hardware allows.
  2. Start the LM Studio server.
  3. Install Swival (requires Python 3.13+):
uv tool install swival
  1. Run:
swival "Refactor the error handling in src/api.py"

That's it. Swival finds the model, connects, and goes to work.

HuggingFace

export HF_TOKEN=hf_...
uv tool install swival
swival "Refactor the error handling in src/api.py" \
    --provider huggingface --model zai-org/GLM-5

You can also point it at a dedicated endpoint with --base-url and --api-key.

OpenRouter

export OPENROUTER_API_KEY=sk_or_...
uv tool install swival
swival "Refactor the error handling in src/api.py" \
    --provider openrouter --model z-ai/glm-5

Google Gemini

export GEMINI_API_KEY=...
uv tool install swival
swival "Refactor the error handling in src/api.py" \
    --provider google --model gemini-2.5-flash

ChatGPT Plus/Pro

Use OpenAI models through your existing ChatGPT Plus or Pro subscription -- no API key needed.

uv tool install swival
swival "Refactor the error handling in src/api.py" \
    --provider chatgpt --model gpt-5.4

On first use, a device code and URL are printed to your terminal. Open the URL, enter the code, and authorize with your ChatGPT account. Tokens are cached locally for subsequent runs.

Generic (OpenAI-compatible)

swival "Refactor the error handling in src/api.py" \
    --provider generic \
    --base-url http://127.0.0.1:8080 \
    --model my-model

Works with ollama, llama.cpp, mlx_lm.server, vLLM, and anything else that speaks the OpenAI chat completions protocol. No API key required for local servers.

Interactive sessions

swival --repl

The REPL carries conversation history across questions, which makes it good for exploratory work and longer tasks.

Task Input From Stdin

If you omit the positional task and pipe stdin, Swival reads the task from stdin.

swival -q < objective.md

cat prompts/review.md | swival --provider huggingface --model zai-org/GLM-5

Useful for long prompts, shell-quoting avoidance, and scripted workflows.

Updates and uninstall

uv tool upgrade swival    # update
uv tool uninstall swival  # remove

What makes it different

Reliable with small models. Context management is one of Swival's strengths. It keeps things clean and focused, which is especially important when you are working with models that have tight context windows. Graduated compaction, persistent thinking notes, and a todo checklist all survive context resets, so the agent doesn't lose track of multi-step plans even under pressure.

Your models, your way. Works with LM Studio, HuggingFace Inference API, OpenRouter, Google Gemini, ChatGPT Plus/Pro, and any OpenAI-compatible server. With LM Studio, it auto-discovers whatever model you have loaded. With HuggingFace or OpenRouter, point it at any supported model. With Google Gemini, use Gemini models through Google's native API. With ChatGPT Plus/Pro, authenticate through your browser and use OpenAI's models through your existing subscription. With the generic provider, connect to ollama, llama.cpp, mlx_lm.server, vLLM, or any other compatible server. You pick the model and the infrastructure.

Review loop and LLM-as-a-judge. Swival has a configurable review loop that can run external reviewer scripts or use a built-in LLM-as-judge to automatically evaluate and retry agent output. Good for quality assurance on tasks that matter.

Built for benchmarking. Pass --report report.json and Swival writes a machine-readable evaluation report with per-call LLM timing, tool success/failure counts, context compaction events, and guardrail interventions. Useful for comparing models, settings, skills, and MCP servers systematically on real coding tasks.

Skills, MCP, and A2A. Extend the agent with SKILL.md-based skills for reusable workflows, connect to external tools via the Model Context Protocol, and talk to remote agents via the Agent-to-Agent (A2A) protocol.

Small enough to read and hack. A few thousand lines of Python across a handful of files, with no framework underneath. Read the whole agent in an afternoon. If something doesn't work the way you want, change it.

CLI-native. stdout is exclusively the final answer. All diagnostics go to stderr. Pipe Swival's output straight into another command or a file.

Documentation

Full documentation is available at swival.dev.

  • Getting Started -- installation, first run, what happens under the hood
  • Usage -- one-shot mode, REPL mode, CLI flags, piping, exit codes
  • Tools -- what the agent can do: file ops, search, editing, web fetching, thinking, task tracking, command execution
  • Safety and Sandboxing -- path resolution, symlink protection, command whitelisting, YOLO mode
  • Skills -- creating and using SKILL.md-based agent skills
  • Customization -- config files, project instructions, system prompt overrides, tuning parameters
  • Context Management -- compaction, snapshots, knowledge survival, and how Swival handles tight context windows
  • Providers -- LM Studio, HuggingFace, OpenRouter, Google Gemini, ChatGPT Plus/Pro, and generic OpenAI-compatible server configuration
  • MCP -- connecting external tool servers via the Model Context Protocol
  • A2A -- connecting to remote agents via the Agent-to-Agent protocol
  • Reports -- JSON reports for benchmarking and evaluation
  • Reviews -- external reviewer scripts for automated QA and LLM-as-judge evaluation
  • Using Swival with AgentFS -- copy-on-write filesystem sandboxing for safe agent runs

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

swival-0.1.27.tar.gz (1.9 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

swival-0.1.27-py3-none-any.whl (143.5 kB view details)

Uploaded Python 3

File details

Details for the file swival-0.1.27.tar.gz.

File metadata

  • Download URL: swival-0.1.27.tar.gz
  • Upload date:
  • Size: 1.9 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.10.10 {"installer":{"name":"uv","version":"0.10.10","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for swival-0.1.27.tar.gz
Algorithm Hash digest
SHA256 5c149d21547a9a46d87e9c5545cc200c44e3da6a716895e6273bc689de9ae579
MD5 ea40ca25f330a1ba1c7c5b48529d6cbb
BLAKE2b-256 c62fd18617fe4c1cc5d45ec5cb4b9dd8f52700024691cdf22470521baead70df

See more details on using hashes here.

File details

Details for the file swival-0.1.27-py3-none-any.whl.

File metadata

  • Download URL: swival-0.1.27-py3-none-any.whl
  • Upload date:
  • Size: 143.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.10.10 {"installer":{"name":"uv","version":"0.10.10","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for swival-0.1.27-py3-none-any.whl
Algorithm Hash digest
SHA256 6cea20204a384eb112c66417f82b7c17c170605bf0be197c4d15e905a24a1123
MD5 7227430244e17222001feaaf7c83b708
BLAKE2b-256 2b5abe0f11e21e4fc9b2cb9f0f34359bccc3058e4d524a69c142e8328bef13bf

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page