Skip to main content

An intelligent agent for task automation and assistance

Project description

OnIt

OnIt — the AI is working on the given task and will deliver the results shortly.

OnIt is an intelligent agent for task automation and assistance. It connects to private vLLM servers, OpenRouter.ai, and Ollama cloud for hosted models — and uses MCP tools for web search, file operations, and more. It also supports the A2A protocol for multi-agent communication.

Getting Started

1. Install

pip install onit

Or from source:

git clone https://github.com/sibyl-oracles/onit.git
cd onit
pip install -e ".[all]"

2. Setup

onit setup

The setup wizard walks you through configuring your LLM endpoint, API keys, and preferences. Secrets are stored securely in your OS keychain. Settings are saved to ~/.onit/config.yaml.

To review your configuration at any time:

onit setup --show

3. Run

onit

That's it. MCP tools start automatically, and you get an interactive chat with tool access.

CLI at a Glance

onit                                          # interactive terminal chat
onit setup                                    # configure LLM endpoint, API keys
onit resume [TAG_OR_ID]                       # continue a previous session
onit sessions                                 # list saved sessions

onit serve a2a                                # A2A protocol server (port 9001)
onit serve web                                # Gradio web UI (port 9000)
onit serve gateway [telegram|viber|auto]      # Telegram or Viber bot
onit serve loop "task" --period 60            # repeat a task on a timer

onit ask "what is the weather in Manila"      # send a task to a running A2A server

onit --container                              # run in a hardened Docker container
onit --sandbox                                # delegate code execution to a sandbox
onit --unrestricted                           # unrestricted host filesystem access

Configuration

onit setup is the recommended way to configure OnIt. It stores:

  • Settings in ~/.onit/config.yaml (LLM endpoint, theme, ports, timeout)
  • Secrets in your OS keychain (API keys, bot tokens)

You can also use environment variables or a project-level YAML config:

# Environment variables
export ONIT_HOST=https://openrouter.ai/api/v1
export OPENROUTER_API_KEY=sk-or-v1-...

# Or a custom config file
onit --config configs/default.yaml

Priority order: CLI flags > environment variables > ~/.onit/config.yaml > project config file.

Example config (configs/default.yaml)

serving:
  host: https://openrouter.ai/api/v1
  host_key: sk-or-v1-your-key-here   # or set OPENROUTER_API_KEY env var
  # model: auto-detected from endpoint. Set explicitly for OpenRouter:
  # model: google/gemini-2.5-pro
  think: true
  max_tokens: 262144
  # Sampling parameters (all optional — sensible defaults apply):
  # temperature: 1.0
  # top_p: 0.95
  # top_k: 20
  # presence_penalty: 1.5
  # repetition_penalty: 1.0

verbose: false
timeout: 600
sandbox: false

web_port: 9000
a2a_port: 9001

theme: white         # or "dark"
topic: ~             # default topic context, e.g. "machine learning"
template_path: ~     # custom prompt template YAML
documents_path: ~    # local documents directory
data_path: ~         # working directory for file operations (default: system temp)

mcp:
  servers:
    - name: PromptsMCPServer
      url: http://127.0.0.1:18200/sse
      enabled: true
    - name: ToolsMCPServer
      url: http://127.0.0.1:18201/sse
      enabled: true

Sampling parameters

Sampling parameters (temperature, top_p, top_k, min_p, presence_penalty, repetition_penalty) are set in configs/default.yaml under serving:. They are not exposed as CLI flags to keep the command line clean.

Recommended parameters for Qwen3.5:

Mode Use case temperature top_p top_k presence_penalty
Thinking (think: true) General 1.0 0.95 20 1.5
Thinking (think: true) Precise coding 0.6 0.95 20 0.0
Instruct (no think) General 0.7 0.8 20 1.5
Instruct (no think) Reasoning 1.0 1.0 40 2.0

Set repetition_penalty: 1.0 in all cases.

CLI Reference

Interactive chat (default)

onit [OPTIONS]

Starts an interactive terminal chat with tool access. MCP servers start automatically.

Flag Description Default
--config FILE Path to YAML configuration file configs/default.yaml
--host URL LLM serving host URL. Overrides config and ONIT_HOST
--model NAME Model name. Skips auto-detection from endpoint
--verbose Enable verbose logging false
--think Enable thinking/reasoning mode (CoT) false
--no-stream Disable token streaming false
--show-logs Show tool execution logs false
--plan FILE Path to a .md or .txt plan file; contents become the system prompt
--resume TAG_OR_ID Resume a previous session by tag, UUID, or last
--sandbox Delegate code execution to an external MCP sandbox provider false
--unrestricted Unrestricted host filesystem access (trusted environments only) false
--container Run the entire OnIt process inside a hardened Docker container false
--mcp-sse URL Add an external MCP server (SSE transport, repeatable)
--mcp-server URL Add an external MCP server (Streamable HTTP transport, repeatable)

onit setup

Interactive setup wizard. Configures the LLM endpoint, API keys, and preferences. Stores settings in ~/.onit/config.yaml and secrets in the OS keychain.

onit setup           # run the wizard
onit setup --show    # print current configuration

onit sessions

List and manage saved sessions.

onit sessions                          # list recent sessions (default: 20)
onit sessions --limit 50               # list up to 50 sessions
onit sessions --tag abc123 "my-chat"   # tag a session for easy recall
onit sessions --rebuild                # rebuild session index from JSONL files
onit sessions --clear                  # delete all session history

onit resume

Resume a previous session by tag or UUID.

onit resume              # resume the most recent session
onit resume my-chat      # resume by tag
onit resume abc123       # resume by session UUID prefix

Equivalent to onit --resume TAG_OR_ID.

onit ask

Send a single task to a running OnIt A2A server and print the response. Useful for scripting, pipelines, or one-shot queries without starting a local agent.

onit ask "what is the weather in Manila"
onit ask "summarize this document" --file report.pdf
onit ask "describe this image" --image photo.jpg
onit ask "write a script" --server http://192.168.1.10:9001
Argument / Flag Description Default
task (positional) Task to send to the server required
--file PATH File to upload along with the task
--image PATH Image file for vision processing (model must be a VLM)
--server URL A2A server URL http://localhost:9001

onit serve

Run OnIt in a persistent server or daemon mode. All serve modes run indefinitely until interrupted (Ctrl+C).

onit serve a2a

Run OnIt as an A2A protocol server so other agents or clients can send tasks.

onit serve a2a                 # listen on port 9001 (default)
onit serve a2a --port 9100     # custom port
Flag Description Default
--port PORT A2A server port 9001 (or a2a_port in config)

The agent card is available at http://localhost:9001/.well-known/agent.json.

Send a task from another agent (Python A2A SDK):

from a2a.client import ClientFactory, create_text_message_object
from a2a.types import Role
import asyncio

async def main():
    client = await ClientFactory.connect("http://localhost:9001")
    message = create_text_message_object(role=Role.user, content="What is the weather?")
    async for event in client.send_message(message):
        print(event)

asyncio.run(main())

onit serve web

Launch the Gradio web chat UI.

onit serve web                 # open on port 9000 (default)
onit serve web --port 9500     # custom port
Flag Description Default
--port PORT Web UI port 9000 (or web_port in config)

Supports optional Google OAuth2 authentication — see docs/WEB_AUTHENTICATION.md.

onit serve gateway

Run OnIt as a Telegram or Viber bot. Configure bot tokens via onit setup or environment variables.

onit serve gateway                                      # auto-detect from env vars
onit serve gateway telegram                             # Telegram bot
onit serve gateway viber --webhook-url https://...      # Viber bot
Argument / Flag Description Default
gateway_type (positional) telegram, viber, or auto auto
--webhook-url URL Public HTTPS URL for Viber webhook (or set VIBER_WEBHOOK_URL)
--port PORT Local port for Viber webhook server 8443 (or viber_port in config)

Required environment variables (set via onit setup or export):

  • Telegram: TELEGRAM_BOT_TOKEN
  • Viber: VIBER_BOT_TOKEN, VIBER_WEBHOOK_URL

Install gateway dependencies if not using [all]:

pip install "onit[gateway]"

onit serve loop

Repeat a task on a configurable timer. Useful for monitoring, polling, or autonomous scheduled work.

onit serve loop "check the weather in Manila" --period 60
onit serve loop "summarize today's news" --period 3600
Argument / Flag Description Default
task (positional) Task to execute repeatedly required
--period SECONDS Seconds between iterations 10 (or period in config)

Isolation Modes

OnIt offers three isolation levels. They can be combined (e.g. --container --sandbox).

--sandbox

Delegates individual code-execution tool calls to an external MCP sandbox provider. Complementary to --container.

onit --sandbox
onit --container --sandbox   # defense in depth

Requires an MCP server that provides sandbox tools (sandbox_run_code, sandbox_install_packages, sandbox_stop). Set sandbox: true in config.yaml to enable by default.

--container

Runs the entire OnIt process inside a hardened Docker container so a breach cannot reach the host OS.

onit --container                                          # interactive terminal in container
onit --container serve web                                # web UI, port 9000 published
onit --container serve a2a --port 9100                    # A2A server on custom port
onit --container --container-gpus all                     # NVIDIA GPU pass-through
onit --container --container-mount "$HOME/docs:/home/onit/documents:ro" \
  serve web                                               # expose host path read-only
onit --container --sandbox                                # combine with per-tool sandboxing

The first run auto-builds the onit:local image from the repo Dockerfile. Subsequent runs reuse the image.

Container sub-flags:

Flag Description
--container-gpus SPEC NVIDIA GPU pass-through (e.g. all, "device=0,1"). Requires NVIDIA Container Toolkit.
--container-mount HOST:CONTAINER[:ro] Extra bind mount. Repeatable. Prefer :ro.
--container-memory SIZE Hard memory cap (e.g. 16g). Default: unlimited.
--container-shm-size SIZE /dev/shm size (default: 4g). Raise for PyTorch DataLoader.
--container-tmp-size SIZE /tmp tmpfs size (default: 16g). Backed by host RAM.

Isolation posture: non-root user, read-only rootfs, --cap-drop=ALL, no host mounts by default, outbound network allowed.

What crosses the boundary:

Resource Default behavior
~/.onit/config.yaml Bind-mounted read-only
Host keychain secrets Passed as ephemeral env vars
Session data Named volume onit-data (writable, persistent)
Ports Published only for the active mode
Host filesystem Nothing beyond config/secrets unless --container-mount is set

Published ports by mode:

Mode Default port Override
(terminal) — (no ports)
serve web 9000:9000 --port
serve a2a 9001:9001 --port
serve gateway viber 8443:8443 --port

See docs/DOCKER.md for full details.

--unrestricted

Runs OnIt with lifted filesystem restrictions on the host — the agent can read/write any path, use any working directory, and install packages freely (pip, apt, brew, etc.). Use only in trusted, isolated environments.

onit --unrestricted

Catastrophic commands (disk wipe, reboot, kernel module loading) are always blocked regardless of this flag.

MCP Tool Integration

MCP servers start automatically. Tools are auto-discovered and available to the agent.

Server Description
PromptsMCPServer Prompt templates for instruction generation
ToolsMCPServer Web search, bash commands, file operations, and document tools

Connect to additional external MCP servers:

onit --mcp-sse http://localhost:8080/sse
onit --mcp-server http://localhost:8080/mcp

Model Serving

Private vLLM

Serve models locally with vLLM:

CUDA_VISIBLE_DEVICES=0,1,2,3 vllm serve Qwen/Qwen3-30B-A3B-Instruct-2507 \
  --max-model-len 262144 --port 8000 \
  --enable-auto-tool-choice --tool-call-parser hermes \
  --reasoning-parser qwen3 --tensor-parallel-size 4 \
  --chat-template-content-format string
onit --host http://localhost:8000/v1

OpenRouter.ai

OpenRouter gives access to models from OpenAI, Google, Meta, Anthropic, and others through a single API.

onit --host https://openrouter.ai/api/v1

Browse available models at openrouter.ai/models.

Ollama Cloud

Ollama cloud hosts models accessed via the native Ollama Python SDK. Store your API key once:

onit setup   # enter your Ollama API key when prompted

Or set the environment variable:

export OLLAMA_API_KEY=your-ollama-key

Then point OnIt at the Ollama cloud host and specify a model:

onit --host https://api.ollama.com --model gemma4:31b-cloud
onit --host https://api.ollama.com --model llama4:scout-cloud

Model is auto-detected from the endpoint if --model is omitted. You can also set the host permanently in your config:

serving:
  host: https://api.ollama.com
  model: gemma4:31b-cloud

Note: Ollama cloud uses the ollama_api_key keyring entry (the same key used for the web search tool).

Architecture

┌─────────────────────────────────────────────────────┐
│                       onit CLI                      │
│                  (argparse + YAML config)           │
└────────────────────────┬────────────────────────────┘
                         │
                         ▼
┌─────────────────────────────────────────────────────┐
│                     OnIt (src/onit.py)              │
│                                                     │
│  ┌─────────┐ ┌──────────┐ ┌──────────┐ ┌────────┐ ┌──────┐ │
│  │ ChatUI  │ │ WebChatUI│ │ Telegram │ │ Viber  │ │ A2A  │ │
│  │(terminal│ │ (Gradio) │ │ Gateway  │ │Gateway │ │Server│ │
│  └────┬────┘ └────┬─────┘ └────┬─────┘ └───┬────┘ └──┬───┘ │
│       └─────────┬─┘            │             │       │
│                 ▼                 ▼                 │
│          client_to_agent()  /  process_task()       │
│                 │                                   │
│                 ▼                                   │
│        MCP Prompt Engineering (FastMCP)             │
│                 │                                   │
│                 ▼                                   │
│         chat() ◄──── Tool Registry                  │
│  (vLLM / OpenRouter / Ollama cloud) (auto-discovered) │
└─────────────────────────────────────────────────────┘
                         │
            ┌────────────┼────────────┐
            ▼            ▼            ▼
     ┌───────────┐ ┌──────────┐ ┌──────────┐
     │  Prompts  │ │  Tools   │ │ External │  ...
     │ MCP Server│ │MCP Server│ │MCP (SSE) │
     └───────────┘ └──────────┘ └──────────┘

Project Structure

onit/
├── configs/
│   └── default.yaml            # Agent configuration
├── pyproject.toml              # Package configuration
├── src/
│   ├── cli.py                  # CLI entry point
│   ├── setup.py                # Setup wizard (onit setup)
│   ├── onit.py                 # Core agent class
│   ├── lib/
│   │   ├── text.py             # Text utilities
│   │   └── tools.py            # MCP tool discovery
│   ├── mcp/
│   │   ├── prompts/            # Prompt engineering (FastMCP)
│   │   └── servers/            # MCP servers (tools, web, bash, filesystem)
│   ├── type/
│   │   └── tools.py            # Tool registry and schema utilities
│   ├── model/
│   │   └── serving/
│   │       └── chat.py         # LLM interface (vLLM, OpenRouter, Ollama cloud)
│   ├── ui/
│   │   ├── text.py             # Rich terminal UI
│   │   ├── web.py              # Gradio web UI
│   │   ├── telegram.py         # Telegram bot gateway
│   │   └── viber.py            # Viber bot gateway
│   └── test/                   # Test suite (pytest)

Documentation

License

Apache License 2.0. See LICENSE for details.

Project details


Download files

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

Source Distribution

onit-0.1.4a0.tar.gz (187.7 kB view details)

Uploaded Source

Built Distribution

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

onit-0.1.4a0-py3-none-any.whl (211.5 kB view details)

Uploaded Python 3

File details

Details for the file onit-0.1.4a0.tar.gz.

File metadata

  • Download URL: onit-0.1.4a0.tar.gz
  • Upload date:
  • Size: 187.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for onit-0.1.4a0.tar.gz
Algorithm Hash digest
SHA256 3e76548695dd68bbf83097f8878e044100d92c96d15d5b4473f228e44f26709d
MD5 e92e9b02d16131025bba1bdcf58dd2f6
BLAKE2b-256 6b4f6d0cba0e82470a273a48b0679f12763aa04fa6acd66c88f53cfbbe58dad3

See more details on using hashes here.

Provenance

The following attestation bundles were made for onit-0.1.4a0.tar.gz:

Publisher: publish.yml on sibyl-oracles/onit

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file onit-0.1.4a0-py3-none-any.whl.

File metadata

  • Download URL: onit-0.1.4a0-py3-none-any.whl
  • Upload date:
  • Size: 211.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for onit-0.1.4a0-py3-none-any.whl
Algorithm Hash digest
SHA256 725fffcd6e4c90cf848fd74679827c8a47247b1b94b0dc1b7e54f48ef0eb25bb
MD5 6a2da52b527fd3e25482828a94ed975a
BLAKE2b-256 940c8af673ae7a0ae5117ea22931a019ce1cc9dff33aae9e371a81bd717a6567

See more details on using hashes here.

Provenance

The following attestation bundles were made for onit-0.1.4a0-py3-none-any.whl:

Publisher: publish.yml on sibyl-oracles/onit

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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