Skip to main content

A lean Python harness for running persistent AI agents

Project description

Clawsome

Clawsome

A lean python harness for running persistent AI agents.

Clawsome is under early, active development. Expect rough edges, breaking changes, and missing features. Feedback and contributions are welcome.


Setup

Clawsome talks to a few external services (Ollama, SearXNG, a Matrix homeserver) — get those running first, then pip install -e . and point claw at a populated claw.yaml.

→ See docs/setup.md for prerequisites, install notes (including the macOS libolm wrinkle), and a first-boot checklist.

Architecture

A single clawsome process manages multiple agents, each with a workspace (state on disk) and one or more channels (inbound surfaces — Matrix is the shipped one). Per-turn, the agent loads its transcript, assembles a system prompt from injected identity files + retrieved memory, runs an Ollama tool loop, and replies. Background tasks (compaction, memory_flush, reindex, cron, session rotate) run off the user-reply path. An optional control plane lets allowlisted operators run in-band admin commands (%stop, %compact, %clear, …) that are intercepted before the model and never enter the transcript.

→ See docs/architecture.md for the full mental model, request lifecycle, and workspace file contract.

Configuration

claw.yaml is parsed once at startup; editing requires a restart. The shipped claw.example.yaml is a runnable template with inline comments.

→ See docs/configuration.md for the full key-by-key reference.

Operations

Background tuning, daily session rotate, memory retrieval cadence, Matrix bot first-deploy (token + cross-signing UIA + ghost-DM avoidance), the admin-command runbook (%stop/%compact/%clear/%subagents/ %verbose/%thinking), and log-based troubleshooting.

→ See docs/operations.md.

Extending

Three extension points: skills (workspace-local; markdown protocol + optional tool.py), built-in tools (in-tree; universal capability), channels (in-tree; new inbound surface). Skills cover 99% of cases.

→ See docs/extending.md.

Deployment

pip install exposes a claw console script that takes --config <path/to/claw.yaml> and runs in the foreground. Wire it into launchd / systemd / your process manager of choice as a long-lived service running under a dedicated user. This repo intentionally does not ship example service files — paths, log destinations, and label/unit names all depend on the host layout.


Contributing

Issues and pull requests are welcome on GitHub.

Tests

pip install -e ".[dev]"   # pytest + pytest-asyncio
pytest -q

Pure-logic unit tests plus one Agent smoke test — no live Ollama, Matrix, or network needed (fakes + tmp_path throughout); runs in under a second. Tests use neutral placeholders only (no real hostnames or MXIDs) — please keep new ones that way.

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

clawsome-2026.5.17.tar.gz (101.9 kB view details)

Uploaded Source

Built Distribution

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

clawsome-2026.5.17-py3-none-any.whl (104.0 kB view details)

Uploaded Python 3

File details

Details for the file clawsome-2026.5.17.tar.gz.

File metadata

  • Download URL: clawsome-2026.5.17.tar.gz
  • Upload date:
  • Size: 101.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.13

File hashes

Hashes for clawsome-2026.5.17.tar.gz
Algorithm Hash digest
SHA256 dc3f5ed95ac92a0f02fcd0fe28deadfa6ba3181125736d0ab98a26d00546ce39
MD5 a946c74ced6a88c7c3c903dbb242e0be
BLAKE2b-256 6f7520d4614034d6d0340d09223e1c8f7594ec4de8e42ad1912a4fa70df21631

See more details on using hashes here.

File details

Details for the file clawsome-2026.5.17-py3-none-any.whl.

File metadata

  • Download URL: clawsome-2026.5.17-py3-none-any.whl
  • Upload date:
  • Size: 104.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.13

File hashes

Hashes for clawsome-2026.5.17-py3-none-any.whl
Algorithm Hash digest
SHA256 5423ee43a5800c864c9144a65fc4125da82b0667be2bb826f01eb9e9d1bd138a
MD5 b1c8e9ce2b61ab14d50fc47d20bcee76
BLAKE2b-256 388fe38bd26ef84b840bf61132f101bf2130b0967530947b3b2cfecb182dadaf

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