Skip to main content

ProtocolCity BluePrint — found a city, serve the Office (cabinets home; map annex)

Project description

🏙️ ProtocolCity-BluePrint

Pre-release (0.1.x). The roof of the ProtocolCity suite — WorkLane (desk) · WorkForce (roster) · this BluePrint (map + suite CLI). Expect sharp edges; file issues.

The blueprint for running your own city of AI agents — and the installable suite that makes Map · Desk · Roster real on a laptop.

Install the suite (recommended)

brew install protocolcity/tap/protocolcity
protocolcity found ~/my-city
protocolcity serve --with-engines
# → http://127.0.0.1:8801/  (Map · Desk · Roster)

That one formula installs the BluePrint CLI and pulls WorkLane + WorkForce from PyPI. Product source repos stay separate; install does not require cloning them.

Or: pip install protocolcity protocolcity-worklane protocolcity-workforce

Spec + paper

Protocol City is also a specification for organizing a workspace so humans and AI agents from any vendor can build together, in parallel, accountably. You can adopt the paper path with a text editor and the templates below.

Every bot is a worker, every .md is a law, and every contributor becomes a citizen.

Why

Agents are brilliant and unaccountable. Every vendor wants orchestration to live inside its own runtime, in its own config format. Decisions evaporate in chat windows. The Blueprint is the opposite bet: coordination as a protocol — files, tickets, and signed work — durable, auditable, human-readable, and owned by you.

WorkLane gives you the desk. WorkForce gives you the workforce. The Blueprint gives you the map.

What's inside

Document What it is
CHARTER.md The spec: definitions, the three layers, the four levels of law, the compliance test, and the founding path
MANIFESTO.md Why the city exists — what we believe and the wager we're making
FOUNDING.md Day one: find your neighborhoods, copy the templates, pass the compliance test — an afternoon, start to finish
RUNNING.md Every day after: the loops, the five citizen duties, the flywheel — and what runs itself
templates/ Fill-in-the-blank law files for all four levels, plus vendor pointers
example/ Riverside — a complete minimal city (one root, one neighborhood, one worker), every template filled in

The short version

A city is your whole operation. Each project is a neighborhood. Work moves only by ticket through the work-order desk. Your agents are the workforce — any vendor, each with a registered identity that signs everything it does. The rules are laws: plain markdown files at four levels, from city-wide law down to a single worker's shift instructions.

A project is protocol-compliant when three things are true:

  1. Its law is written — an AGENTS.md at its root.
  2. Its work is ticketed — filed at the desk, explicit scope.
  3. Its workers sign — every action carries a registered identity.

Start with one neighborhood, one worker, one law — FOUNDING.md walks you through it, and there's nothing to install: adopting the Blueprint is copying templates and filling them in.

Status

v0.1.x pre-release. Install path (Homebrew / PyPI) is live. Suite UX is still sharpening. The Blueprint is extracted from a working city: one operator, one machine, multiple products, agents from several vendors. Expect the spec and the shell to move quickly.

License

CC BY 4.0 — use it, adapt it, build your city on it, with attribution.

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

protocolcity-0.1.6.tar.gz (326.8 kB view details)

Uploaded Source

Built Distribution

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

protocolcity-0.1.6-py3-none-any.whl (349.3 kB view details)

Uploaded Python 3

File details

Details for the file protocolcity-0.1.6.tar.gz.

File metadata

  • Download URL: protocolcity-0.1.6.tar.gz
  • Upload date:
  • Size: 326.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.9.6

File hashes

Hashes for protocolcity-0.1.6.tar.gz
Algorithm Hash digest
SHA256 be6c6fd3b2d4d8c7ba818fcdefa0bf5c8988540db7ea893fa8952a2aaa8f9a94
MD5 13322b1a3068773e50b7249695732eb3
BLAKE2b-256 80780cc728b4b924313da58c443b6a67cffe95e00160c8c19705ce603f0b8e15

See more details on using hashes here.

File details

Details for the file protocolcity-0.1.6-py3-none-any.whl.

File metadata

  • Download URL: protocolcity-0.1.6-py3-none-any.whl
  • Upload date:
  • Size: 349.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.9.6

File hashes

Hashes for protocolcity-0.1.6-py3-none-any.whl
Algorithm Hash digest
SHA256 794085ecd8b7a97616b1c0fa519ba178f38624d692740d6ff6a65356dadbe851
MD5 fdec67fb159141b082a33865fc6e320d
BLAKE2b-256 cb4096add9d1af933e4d09382717a1e423777667bf56cc5382b3e75085c98867

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