arqux 1.0.0__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- arqux-1.0.0/AGENTS.md +295 -0
- arqux-1.0.0/CHANGELOG.md +32 -0
- arqux-1.0.0/LICENSE +201 -0
- arqux-1.0.0/MANIFEST.in +8 -0
- arqux-1.0.0/PKG-INFO +235 -0
- arqux-1.0.0/README.md +199 -0
- arqux-1.0.0/pyproject.toml +92 -0
- arqux-1.0.0/setup.cfg +4 -0
- arqux-1.0.0/skills/INDEX.md +9 -0
- arqux-1.0.0/skills/README.md +48 -0
- arqux-1.0.0/skills/cycle-retrospective.md +117 -0
- arqux-1.0.0/skills/evidence-capture.md +62 -0
- arqux-1.0.0/skills/governance-bootstrap.md +59 -0
- arqux-1.0.0/src/arqux/__init__.py +28 -0
- arqux-1.0.0/src/arqux/__main__.py +6 -0
- arqux-1.0.0/src/arqux/cli.py +102 -0
- arqux-1.0.0/src/arqux/constants.py +184 -0
- arqux-1.0.0/src/arqux/cortex_out.py +124 -0
- arqux-1.0.0/src/arqux/handlers/__init__.py +336 -0
- arqux-1.0.0/src/arqux/handlers/cycle.py +147 -0
- arqux-1.0.0/src/arqux/handlers/evidence.py +118 -0
- arqux-1.0.0/src/arqux/handlers/project.py +178 -0
- arqux-1.0.0/src/arqux/handlers/protocol.py +127 -0
- arqux-1.0.0/src/arqux/handlers/task.py +382 -0
- arqux-1.0.0/src/arqux/handlers/workspace.py +133 -0
- arqux-1.0.0/src/arqux/identities/auditor.cortex +41 -0
- arqux-1.0.0/src/arqux/identities/auditor.md +19 -0
- arqux-1.0.0/src/arqux/identities/executor.cortex +49 -0
- arqux-1.0.0/src/arqux/identities/executor.md +20 -0
- arqux-1.0.0/src/arqux/identities/governor.cortex +39 -0
- arqux-1.0.0/src/arqux/identities/governor.md +21 -0
- arqux-1.0.0/src/arqux/permissions.py +161 -0
- arqux-1.0.0/src/arqux/server.py +133 -0
- arqux-1.0.0/src/arqux/state.py +672 -0
- arqux-1.0.0/src/arqux/templates/brain.cortex +43 -0
- arqux-1.0.0/src/arqux/templates/brain.md +46 -0
- arqux-1.0.0/src/arqux/templates/meta-brain.cortex +22 -0
- arqux-1.0.0/src/arqux/templates/meta-brain.md +24 -0
- arqux-1.0.0/src/arqux/templates/task.cortex +31 -0
- arqux-1.0.0/src/arqux/templates/task.md +30 -0
- arqux-1.0.0/src/arqux.egg-info/PKG-INFO +235 -0
- arqux-1.0.0/src/arqux.egg-info/SOURCES.txt +56 -0
- arqux-1.0.0/src/arqux.egg-info/dependency_links.txt +1 -0
- arqux-1.0.0/src/arqux.egg-info/entry_points.txt +2 -0
- arqux-1.0.0/src/arqux.egg-info/requires.txt +12 -0
- arqux-1.0.0/src/arqux.egg-info/top_level.txt +1 -0
- arqux-1.0.0/tests/__init__.py +1 -0
- arqux-1.0.0/tests/conftest.py +51 -0
- arqux-1.0.0/tests/test_cortex_out.py +67 -0
- arqux-1.0.0/tests/test_cycle.py +71 -0
- arqux-1.0.0/tests/test_evidence.py +75 -0
- arqux-1.0.0/tests/test_permissions.py +93 -0
- arqux-1.0.0/tests/test_project.py +109 -0
- arqux-1.0.0/tests/test_protocol.py +44 -0
- arqux-1.0.0/tests/test_registry.py +59 -0
- arqux-1.0.0/tests/test_rename.py +179 -0
- arqux-1.0.0/tests/test_task.py +115 -0
- arqux-1.0.0/tests/test_workspace.py +52 -0
arqux-1.0.0/AGENTS.md
ADDED
|
@@ -0,0 +1,295 @@
|
|
|
1
|
+
# AGENTS.md — Arqux
|
|
2
|
+
|
|
3
|
+
> Single entry point for any AI agent adopting this framework.
|
|
4
|
+
> If you are reading this, you are expected to be able to operate after this file alone.
|
|
5
|
+
> Format: CORTEX (machine-optimized). A human-readable HCORTEX version exists at `AGENTS.md`.
|
|
6
|
+
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
## 1. What Arqux is
|
|
10
|
+
|
|
11
|
+
Arqux is the minimum-viable governance framework for AI agent teams. It is **not** an orchestrator, a CI/CD system, or a project manager. It is a small protocol layer that lets multiple agents work in the same workspace without stepping on each other: a **governor** decides what to do, an **executor** does it and leaves evidence, an **auditor** reads everything but mutates nothing.
|
|
12
|
+
|
|
13
|
+
Every state mutation flows through a fixed budget of **24 MCP handlers** grouped in **6 modules**. There is no direct file editing of governance state — handlers are the interface, files are the storage. The framework persists state via the [CODEC-CORTEX](https://github.com/FidelErnesto03/codec-cortex) codec, which produces `.cortex` (machine-optimized) and `.md` (human-readable) files in sync.
|
|
14
|
+
|
|
15
|
+
You should adopt this framework when: you are working in a workspace with more than one agent, you need traceability of decisions, you need clean role separation, or you need cross-project learning. You should **not** adopt it for single-agent throwaway work, for CI/CD pipelines, or as a project manager.
|
|
16
|
+
|
|
17
|
+
## 2. How to detect Arqux
|
|
18
|
+
|
|
19
|
+
Walk up the directory tree from your current working directory. If you find a directory named `.arqux/` containing `manifest.cortex`, you are inside a governed workspace. If you also find a `.arqux/brain.cortex` in your immediate project directory, that project is governed too.
|
|
20
|
+
|
|
21
|
+
If no `.arqux/` is found, the workspace is not initialized. Ask the human whether to run `arqux init` or wait for instructions. **Do not** initialize without explicit confirmation.
|
|
22
|
+
|
|
23
|
+
## 3. STANDBY-FIRST
|
|
24
|
+
|
|
25
|
+
Every session begins in standby. There is no auto-recovery of context, no auto-binding to a project, no automatic handler invocation. Your **first response to the human must be an open question** — typically some variant of "What would you like me to work on?".
|
|
26
|
+
|
|
27
|
+
When the human gives you a goal, you may invoke `workspace.status` and `project.status` to load context. Do not invoke any handler that mutates state (`task.create`, `cycle.create`, `task.claim`, etc.) without explicit confirmation from the human or from a governor agent.
|
|
28
|
+
|
|
29
|
+
If the human says `@arqux:off`, you must fully detach: forget your identity binding, do not invoke governance handlers, and behave as if the framework does not exist. If the human says `@arqux:pause`, suspend governance without losing state — you can resume with `@arqux:resume`.
|
|
30
|
+
|
|
31
|
+
## 4. Handlers — full table (24, fixed budget)
|
|
32
|
+
|
|
33
|
+
| # | Handler | Signature | Purpose |
|
|
34
|
+
|---|---|---|---|
|
|
35
|
+
| 1 | `workspace.init` | `(path?)` | Initialize `.arqux/` at workspace root |
|
|
36
|
+
| 2 | `workspace.status` | `(verbose?)` | Workspace status (OUT-MIN by default) |
|
|
37
|
+
| 3 | `workspace.lessons` | `(project?)` | List lessons elevated to meta-brain |
|
|
38
|
+
| 4 | `project.init` | `(name, path?)` | Initialize `.arqux/` in a project, register in workspace |
|
|
39
|
+
| 5 | `project.bind` | `(agent_id, role)` | Bind an agent identity to current project |
|
|
40
|
+
| 6 | `project.unbind` | `(agent_id)` | Release an agent binding |
|
|
41
|
+
| 7 | `project.status` | `()` | Active project status (cycles, tasks, agents) |
|
|
42
|
+
| 8 | `project.lessons` | `()` | List lessons local to current project |
|
|
43
|
+
| 9 | `cycle.create` | `(name?, description?)` | Open a new cycle in the active project |
|
|
44
|
+
| 10 | `cycle.list` | `(status?)` | List cycles in active project |
|
|
45
|
+
| 11 | `cycle.current` | `()` | Get the currently active cycle |
|
|
46
|
+
| 12 | `cycle.close` | `(cycle_id, summary?)` | Close a cycle (no new tasks can be added) |
|
|
47
|
+
| 13 | `task.create` | `(obj, pre?, proc?, ac?, blk?, assignee?, complexity?)` | Create a governed task in current cycle |
|
|
48
|
+
| 14 | `task.claim` | `(task_id)` | An executor claims a task → status: in_progress |
|
|
49
|
+
| 15 | `task.update` | `(task_id, note, status?)` | Update task progress, optionally change status |
|
|
50
|
+
| 16 | `task.complete` | `(task_id, evidence?)` | Mark task done, record evidence |
|
|
51
|
+
| 17 | `task.fail` | `(task_id, reason)` | Mark task blocked, record cause |
|
|
52
|
+
| 18 | `task.read` | `(task_id, format?)` | Read a task (CORTEX or HCORTEX) |
|
|
53
|
+
| 19 | `task.list` | `(status?, assignee?, cycle?)` | List tasks with filters |
|
|
54
|
+
| 20 | `evidence.record` | `(task_id, kind, payload)` | Append evidence entry to `pulse.jsonl` |
|
|
55
|
+
| 21 | `evidence.list` | `(task_id?, cycle?, since?, limit?)` | Query evidence trail |
|
|
56
|
+
| 22 | `evidence.read` | `(event_id)` | Read a single evidence event |
|
|
57
|
+
| 23 | `protocol.adopt` | `(agent_id, role)` | Onboard an agent with a role |
|
|
58
|
+
| 24 | `protocol.release` | `(agent_id)` | Fully detach an agent (clean exit, no orphans) |
|
|
59
|
+
|
|
60
|
+
(`protocol.pause` / `protocol.resume` are also exposed but counted as one logical surface — they do not mutate persisted state, only in-process session state.)
|
|
61
|
+
|
|
62
|
+
## 5. Roles and permissions
|
|
63
|
+
|
|
64
|
+
| Role | Allowed handler prefixes | Description |
|
|
65
|
+
|---|---|---|
|
|
66
|
+
| `governor` | `workspace.*`, `project.*`, `cycle.*`, `task.create`, `task.complete`, `task.fail`, `evidence.*`, `protocol.*` | One per workspace. Decides, assigns, approves, closes. |
|
|
67
|
+
| `executor` | `task.claim`, `task.update`, `task.complete`, `task.fail`, `task.read`, `task.list`, `evidence.record`, `evidence.list`, `evidence.read`, `protocol.release` (self) | Picks up tasks and executes them. Cannot create cycles or tasks. |
|
|
68
|
+
| `auditor` | `*.read`, `*.list`, `*.status`, `*.lessons` (read-only handlers) | Read-only. Cannot mutate any state. |
|
|
69
|
+
|
|
70
|
+
Enforcement is at the handler level. If you call a handler outside your role, the system rejects with `PERMISSION_DENIED` and **does not** record the attempt as evidence — the rejection itself is the protocol. There are no exceptions, no escape hatches, no "consultative mode".
|
|
71
|
+
|
|
72
|
+
If you are the first agent to call `workspace.init` on a fresh workspace, you become the governor by default. Subsequent agents must call `protocol.adopt` with a role assigned by the governor.
|
|
73
|
+
|
|
74
|
+
## 6. Task format (CORTEX)
|
|
75
|
+
|
|
76
|
+
Tasks are the atomic unit of work. Each task lives in `.<product>/>cycles/<CYCLE-NN>/tasks/T-NNN.cortex` (machine) with a synced `.md` (human). The CLI `cortex` (provided by CODEC-CORTEX) maintains bidirectional sync.
|
|
77
|
+
|
|
78
|
+
Minimum CORTEX task:
|
|
79
|
+
|
|
80
|
+
```
|
|
81
|
+
---
|
|
82
|
+
id: T-001
|
|
83
|
+
status: draft
|
|
84
|
+
governor: governor
|
|
85
|
+
assignee: executor
|
|
86
|
+
priority: medium
|
|
87
|
+
complexity: standard
|
|
88
|
+
cycle: CYCLE-01
|
|
89
|
+
created: 2026-07-04T10:00:00Z
|
|
90
|
+
updated: 2026-07-04T10:00:00Z
|
|
91
|
+
---
|
|
92
|
+
|
|
93
|
+
# OBJ
|
|
94
|
+
One-sentence objective.
|
|
95
|
+
|
|
96
|
+
# PRE
|
|
97
|
+
- Precondition 1
|
|
98
|
+
- Precondition 2
|
|
99
|
+
|
|
100
|
+
# PROC
|
|
101
|
+
1. Step one
|
|
102
|
+
2. Step two
|
|
103
|
+
|
|
104
|
+
# AC
|
|
105
|
+
- Acceptance criterion 1
|
|
106
|
+
- Acceptance criterion 2
|
|
107
|
+
|
|
108
|
+
# BLK
|
|
109
|
+
- Blocking condition → HALT_AND_REPORT
|
|
110
|
+
```
|
|
111
|
+
|
|
112
|
+
Status transitions: `draft → open → in_progress → review → done`. From any state: `→ blocked` (recoverable) or `→ cancelled` (terminal). No `validation`, no `approved`, no `superseded` — keep it simple.
|
|
113
|
+
|
|
114
|
+
## 7. MCP configuration
|
|
115
|
+
|
|
116
|
+
Add this single block to your MCP client's settings (Gemini / Qwen / Claude / VS Code / Cursor / Hermes):
|
|
117
|
+
|
|
118
|
+
```json
|
|
119
|
+
{
|
|
120
|
+
"mcpServers": {
|
|
121
|
+
"arqux": {
|
|
122
|
+
"command": "arqux",
|
|
123
|
+
"args": ["serve"]
|
|
124
|
+
}
|
|
125
|
+
}
|
|
126
|
+
}
|
|
127
|
+
```
|
|
128
|
+
|
|
129
|
+
No bash scripts. No absolute paths. The `arqux` command is provided by `pip install arqux`.
|
|
130
|
+
|
|
131
|
+
## 8. CORTEX-OUT output protocol
|
|
132
|
+
|
|
133
|
+
Your responses to the human (and to other agents) should follow CORTEX-OUT to minimize tokens and maximize clarity. Pick the profile that matches the context:
|
|
134
|
+
|
|
135
|
+
| Profile | When to use | Example |
|
|
136
|
+
|---|---|---|
|
|
137
|
+
| `OUT-MIN` | Quick status acks, no detail needed | `OK T-001 in_progress` |
|
|
138
|
+
| `OUT-WORK` | Work updates, deliverables, evidence of progress | `DONE T-001 evidence=E-007 coverage=87%` |
|
|
139
|
+
| `OUT-AUDIT` | Architecture reviews, decision logs | `REVIEW cycle=CYCLE-01 risk=low rationale=...` |
|
|
140
|
+
| `OUT-FULL` | Detailed explanations to humans | (full prose, no compression) |
|
|
141
|
+
| `OUT-ERROR` | Failures, blockers, permission denials | `ERROR code=PERMISSION_DENIED handler=task.create reason=executor_role` |
|
|
142
|
+
|
|
143
|
+
Default profile: pick the smallest one that conveys the necessary information. A governor reviewing architecture may use `OUT-AUDIT`; an executor completing a task may use `OUT-WORK`; a quick acknowledgement is `OUT-MIN`. Never use `OUT-FULL` for routine updates — that wastes tokens.
|
|
144
|
+
|
|
145
|
+
## 9. The project brain — shared mind for concurrent agents
|
|
146
|
+
|
|
147
|
+
`brain.cortex` is the **single shared mind of a project**. Every agent bound to the project reads and writes the same brain. This is how multiple agents working concurrently share one project mind: there is no per-agent brain, no per-cycle brain, no separate pulse file — there is ONE brain per project, and every handler that mutates project state writes to it.
|
|
148
|
+
|
|
149
|
+
The brain has nine canonical sections:
|
|
150
|
+
|
|
151
|
+
| Section | Purpose | Written by |
|
|
152
|
+
|---|---|---|
|
|
153
|
+
| `# FOCUS` | One-sentence current focus | Governor |
|
|
154
|
+
| `# OBJECTIVES` | Stable project goals (not tasks) | Governor |
|
|
155
|
+
| `# SESSIONS` | Agents bound to the project (agent, role, status) | `project.bind`, `project.unbind` |
|
|
156
|
+
| `# HANDOFFS` | Chronological log of work handed between agents | Task handlers on transitions |
|
|
157
|
+
| `# PULSE` | Append-only event trace (replaces `pulse.jsonl`) | `evidence.record`, `task.complete`, `task.fail` |
|
|
158
|
+
| `# LESSONS` | Contextual lessons (project-specific) | Governor (via evidence) |
|
|
159
|
+
| `# ACTIVE_CONTEXT` | Currently active cycle/task | Task handlers |
|
|
160
|
+
| `# RISKS` | Project-specific risks | Governor |
|
|
161
|
+
| `# CONCURRENCY` | Optimistic-lock state (`brain_version`) | Every write handler (automatic) |
|
|
162
|
+
|
|
163
|
+
**Why one brain, not many files:** if pulse, handoffs, and sessions lived in separate files, an agent reading the project state would have to open N files and reconcile them. With one brain, the agent reads ONE file and sees the full project mind. This is essential for concurrent work: every agent has the same view.
|
|
164
|
+
|
|
165
|
+
**Concurrency model:** the brain has a `brain_version` counter in its frontmatter. Every mutation bumps it and records the last writer. Before writing, a handler should read the current version; if the version changed since the agent's last read, the handler re-reads and retries. In this minimal implementation, handlers bump the version on every write without retry logic — full optimistic locking is the handler's responsibility (see `state.brain_version`).
|
|
166
|
+
|
|
167
|
+
**What does NOT live in the brain:**
|
|
168
|
+
- Task definitions (`.cortex` per task, in `cycles/<CYCLE>/tasks/`)
|
|
169
|
+
- Cycle metadata (`cycle.cortex` per cycle)
|
|
170
|
+
- Identity behavioral lessons (in the installed package's `agents/<identity>.cortex`)
|
|
171
|
+
- Workspace meta-brain (separate file at the workspace level)
|
|
172
|
+
|
|
173
|
+
## 10. HCORTEX — a form of writing markdown
|
|
174
|
+
|
|
175
|
+
HCORTEX is **a form of writing markdown** oriented to facilitate reading, understanding, and organization, while minimizing token consumption. It is NOT a separate format — it is a discipline for writing markdown that humans read efficiently.
|
|
176
|
+
|
|
177
|
+
### The HCORTEX discipline
|
|
178
|
+
|
|
179
|
+
1. **One section per idea.** Each `#` heading introduces exactly one concept. No multi-idea sections.
|
|
180
|
+
2. **Lists over prose.** Prefer `- ` bullets to paragraphs. Each bullet is a complete, scannable unit.
|
|
181
|
+
3. **Bold the key term.** In each bullet, `**bold**` the noun or verb the reader is looking for. The rest is context.
|
|
182
|
+
4. **Tables for comparisons.** Two or more items with the same attributes → table. Never repeat the same prose structure.
|
|
183
|
+
5. **No redundant headers.** If the body is one line, do not add a header above it — the line stands alone.
|
|
184
|
+
6. **Frontmatter as metadata.** All machine-readable fields (id, status, timestamps) go in YAML frontmatter. The body is for humans.
|
|
185
|
+
7. **No decorative tokens.** No emojis, no horizontal rules between every section, no "------" separators. Whitespace is enough.
|
|
186
|
+
8. **Short sentences.** ≤25 words per sentence. If a sentence is longer, split it.
|
|
187
|
+
9. **Code blocks for commands.** A command to type → fenced code block. Never inline backticks for multi-word commands.
|
|
188
|
+
10. **Round-trip with CORTEX.** Every HCORTEX file has a `.cortex` twin. The CLI `cortex to-machine` regenerates the machine form. Editing one propagates to the other.
|
|
189
|
+
|
|
190
|
+
### Example: HCORTEX vs. plain markdown
|
|
191
|
+
|
|
192
|
+
Plain markdown (verbose, ~80 tokens):
|
|
193
|
+
```markdown
|
|
194
|
+
# Task Status
|
|
195
|
+
|
|
196
|
+
The task T-001 is currently in progress. It was claimed by the executor agent
|
|
197
|
+
identified as "jarvis" at the timestamp 2026-07-04T10:00:00Z. The task is part
|
|
198
|
+
of cycle CYCLE-01, which is the first cycle of the project. The task objective
|
|
199
|
+
is to implement the health check endpoint.
|
|
200
|
+
```
|
|
201
|
+
|
|
202
|
+
HCORTEX (compact, ~25 tokens):
|
|
203
|
+
```markdown
|
|
204
|
+
# T-001
|
|
205
|
+
|
|
206
|
+
- **status:** in_progress
|
|
207
|
+
- **assignee:** jarvis
|
|
208
|
+
- **cycle:** CYCLE-01
|
|
209
|
+
- **objective:** implement health check endpoint
|
|
210
|
+
```
|
|
211
|
+
|
|
212
|
+
Both convey the same information. HCORTEX uses ~30% of the tokens and is faster to scan.
|
|
213
|
+
|
|
214
|
+
### When to use HCORTEX
|
|
215
|
+
|
|
216
|
+
- Always, for `.md` files (the human-readable twin of a `.cortex`).
|
|
217
|
+
- For agent responses to humans when the human needs structured information (use `OUT-WORK` or `OUT-AUDIT` profiles, which follow the same discipline).
|
|
218
|
+
- NOT for prose-heavy explanations to humans — use `OUT-FULL` for those.
|
|
219
|
+
|
|
220
|
+
## 11. CODEC-CORTEX integration
|
|
221
|
+
|
|
222
|
+
State is persisted via CODEC-CORTEX. You should never directly edit `.cortex` or `.md` files — handlers do that, and the CLI `cortex` keeps the two formats in sync.
|
|
223
|
+
|
|
224
|
+
Essential `cortex` commands (provided by the codec-cortex package):
|
|
225
|
+
|
|
226
|
+
- `cortex verify <file.cortex>` — validates structure
|
|
227
|
+
- `cortex to-human <file.cortex>` — emits the `.md` form
|
|
228
|
+
- `cortex to-machine <file.md>` — emits the `.cortex` form
|
|
229
|
+
- `cortex diff <file>` — shows drift between the two forms
|
|
230
|
+
|
|
231
|
+
If `cortex verify` fails on a file produced by a handler, that is a **bug in the handler** — report it as a task (`task.create` with `complexity: bug`).
|
|
232
|
+
|
|
233
|
+
## 12. Learning layers — behavioral vs. contextual
|
|
234
|
+
|
|
235
|
+
The framework has three learning layers, kept strictly separate. An agent conflating them is a design bug.
|
|
236
|
+
|
|
237
|
+
| Layer | Where it lives | What it captures | Scope | Example |
|
|
238
|
+
|---|---|---|---|---|
|
|
239
|
+
| **Behavioral** (identity) | `agents/<identity>.cortex` in the installed package | How a role should act, regardless of project | Cross-project, role-scoped | "Always check permissions before creating a task" (governor lesson) |
|
|
240
|
+
| **Contextual** (project) | `.<product>/brain.cortex` → `# LESSONS` section | What was learned about THIS project | This project only | "We use Redis for caching in this project" |
|
|
241
|
+
| **Global** (workspace) | `.<product>/meta-brain.cortex` | Patterns that apply across all projects | Workspace-wide | "Python 3.10+ is our baseline" |
|
|
242
|
+
|
|
243
|
+
### Behavioral lessons (identity)
|
|
244
|
+
|
|
245
|
+
- Live in the installed package, NOT in any project directory.
|
|
246
|
+
- A governor in project A shares behavioral lessons with a governor in project B.
|
|
247
|
+
- Examples: decision-making patterns, preferred review cadence, how to phrase handoffs.
|
|
248
|
+
- Written by the framework maintainers (or by a future `agent.learn` handler). Project agents do NOT mutate identity files.
|
|
249
|
+
|
|
250
|
+
### Contextual lessons (project)
|
|
251
|
+
|
|
252
|
+
- Live in the project brain's `# LESSONS` section.
|
|
253
|
+
- Apply to THIS project only. A lesson about project A's architecture does not leak into project B.
|
|
254
|
+
- Examples: "this project uses Redis, not Memcached", "the test suite takes 8 minutes, plan accordingly", "module X is deprecated, do not extend it".
|
|
255
|
+
- Written by the governor (typically after a cycle retrospective). Executors record candidate lessons as evidence; the governor promotes them to the brain.
|
|
256
|
+
|
|
257
|
+
### Global lessons (workspace)
|
|
258
|
+
|
|
259
|
+
- Live in the workspace meta-brain's `# LESSONS` section.
|
|
260
|
+
- Apply across all projects in the workspace.
|
|
261
|
+
- Examples: "we standardized on pytest", "every project must have a health check endpoint".
|
|
262
|
+
- Elevated from project brains by the governor when a lesson proves to apply broadly.
|
|
263
|
+
|
|
264
|
+
### Elevation flow
|
|
265
|
+
|
|
266
|
+
```
|
|
267
|
+
evidence.record (kind=note, payload="candidate lesson")
|
|
268
|
+
↓
|
|
269
|
+
project brain # LESSONS (governor promotes after retrospective)
|
|
270
|
+
↓
|
|
271
|
+
meta-brain # LESSONS (governor elevates if cross-project)
|
|
272
|
+
```
|
|
273
|
+
|
|
274
|
+
**Anti-pattern:** an executor writing a behavioral lesson ("I should always run tests before completing") into the project brain. That is a behavioral lesson — it belongs in the executor's identity file, not the project brain.
|
|
275
|
+
|
|
276
|
+
## 13. MCP is the only governance interface
|
|
277
|
+
|
|
278
|
+
Files with the `.cortex` extension (CORTEX protocol) — including `brain.cortex`, `meta-brain.cortex`, `manifest.cortex`, `projects.cortex`, `cycle.cortex`, `T-NNN.cortex`, and `agents/<identity>.cortex` — are **administered and managed exclusively via the framework's MCP handlers**. Direct editing of these files by agents or humans is forbidden.
|
|
279
|
+
|
|
280
|
+
- ✅ To mutate the project brain → call `project.bind`, `task.complete`, `task.fail`, `evidence.record`, etc.
|
|
281
|
+
- ✅ To mutate a task → call `task.create`, `task.update`, `task.complete`, `task.fail`.
|
|
282
|
+
- ✅ To mutate a cycle → call `cycle.create`, `cycle.close`.
|
|
283
|
+
- ✅ To mutate the meta-brain → call `workspace.lessons` (read) — elevation is via handlers.
|
|
284
|
+
- ❌ To "fix" a brain section → do NOT open `brain.cortex` in an editor. If a section is wrong, the handler that wrote it has a bug — file a task.
|
|
285
|
+
- ❌ To "add a quick lesson" → do NOT append to `# LESSONS` directly. Use `evidence.record` with `kind=note` and let the governor promote it.
|
|
286
|
+
|
|
287
|
+
The handler is the interface. The file is the storage. This separation is what guarantees that every mutation is permission-checked, versioned, and traceable.
|
|
288
|
+
|
|
289
|
+
## 14. Dogfooding rule
|
|
290
|
+
|
|
291
|
+
This framework governs its own development. Every feature in this repository is implemented as a governed task in `.arqux/cycles/`. If you find the framework cannot govern its own development — because a handler is missing, because the task format is insufficient, because the permission model blocks you — **that is a bug in the framework, not an invalid use case**. Iterate the framework until it can.
|
|
292
|
+
|
|
293
|
+
---
|
|
294
|
+
|
|
295
|
+
*End of AGENTS.md. If you read this far, you can operate.*
|
arqux-1.0.0/CHANGELOG.md
ADDED
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
# Changelog
|
|
2
|
+
|
|
3
|
+
All notable changes to Arqux are documented here.
|
|
4
|
+
Per the dogfooding rule (§8 of the brief), this file should be generated
|
|
5
|
+
from `evidence.list` rather than written by hand. During initial development
|
|
6
|
+
it is maintained manually; once CYCLE-99 (release v1.0) is governed by the
|
|
7
|
+
framework itself, it will be regenerated from evidence.
|
|
8
|
+
|
|
9
|
+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
|
|
10
|
+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
|
11
|
+
|
|
12
|
+
## [Unreleased]
|
|
13
|
+
|
|
14
|
+
### Added
|
|
15
|
+
- Initial package skeleton with placeholder product name.
|
|
16
|
+
- Six handler modules: `workspace`, `project`, `cycle`, `task`, `evidence`, `protocol`.
|
|
17
|
+
- 24 MCP handlers covering the full governance surface.
|
|
18
|
+
- Three identity roles: `governor`, `executor`, `auditor` with permission middleware.
|
|
19
|
+
- CORTEX-OUT output profiles: `OUT-MIN`, `OUT-WORK`, `OUT-AUDIT`, `OUT-FULL`, `OUT-ERROR`.
|
|
20
|
+
- CLI commands: `arqux serve`, `arqux init`, `arqux status`.
|
|
21
|
+
- CODEC-CORTEX integration via `pyproject.toml` dependency.
|
|
22
|
+
- Rename script `scripts/rename-product.py` for placeholder → real name swap.
|
|
23
|
+
- Dogfooding directory `.arqux/` with `CYCLE-00` initialized.
|
|
24
|
+
- Test suite covering happy paths for every handler module.
|
|
25
|
+
|
|
26
|
+
### Notes
|
|
27
|
+
- Product name is shipped as the `arqux` placeholder token.
|
|
28
|
+
- Run `python scripts/rename-product.py <name>` before `pip install -e .`.
|
|
29
|
+
|
|
30
|
+
## [1.0.0] — TBD
|
|
31
|
+
|
|
32
|
+
Will be tagged when CYCLE-99 (release cycle) is governed end-to-end by the framework itself.
|
arqux-1.0.0/LICENSE
ADDED
|
@@ -0,0 +1,201 @@
|
|
|
1
|
+
Apache License
|
|
2
|
+
Version 2.0, January 2004
|
|
3
|
+
http://www.apache.org/licenses/
|
|
4
|
+
|
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
6
|
+
|
|
7
|
+
1. Definitions.
|
|
8
|
+
|
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
11
|
+
|
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
13
|
+
the copyright owner that is granting the License.
|
|
14
|
+
|
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
16
|
+
other entities that control, are controlled by, or are under common
|
|
17
|
+
control with that entity. For the purposes of this definition,
|
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
19
|
+
direction or management of such entity, whether by contract or
|
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
22
|
+
|
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
24
|
+
exercising permissions granted by this License.
|
|
25
|
+
|
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
27
|
+
including but not limited to software source code, documentation
|
|
28
|
+
source, and configuration files.
|
|
29
|
+
|
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
|
31
|
+
transformation or translation of a Source form, including but
|
|
32
|
+
not limited to compiled object code, generated documentation,
|
|
33
|
+
and conversions to other media types.
|
|
34
|
+
|
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
36
|
+
Object form, made available under the License, as indicated by a
|
|
37
|
+
copyright notice that is included in or attached to the work
|
|
38
|
+
(an example is provided in the Appendix below).
|
|
39
|
+
|
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
46
|
+
the Work and Derivative Works thereof.
|
|
47
|
+
|
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
|
49
|
+
the original version of the Work and any modifications or additions
|
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
61
|
+
|
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
64
|
+
subsequently incorporated within the Work.
|
|
65
|
+
|
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
|
72
|
+
|
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
78
|
+
where such license applies only to those patent claims licensable
|
|
79
|
+
by such Contributor that are necessarily infringed by their
|
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
82
|
+
institute patent litigation against any entity (including a
|
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
85
|
+
or contributory patent infringement, then any patent licenses
|
|
86
|
+
granted to You under this License for that Work shall terminate
|
|
87
|
+
as of the date such litigation is filed.
|
|
88
|
+
|
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
91
|
+
modifications, and in Source or Object form, provided that You
|
|
92
|
+
meet the following conditions:
|
|
93
|
+
|
|
94
|
+
(a) You must give any other recipients of the Work or
|
|
95
|
+
Derivative Works a copy of this License; and
|
|
96
|
+
|
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
|
98
|
+
stating that You changed the files; and
|
|
99
|
+
|
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
|
102
|
+
attribution notices from the Source form of the Work,
|
|
103
|
+
excluding those notices that do not pertain to any part of
|
|
104
|
+
the Derivative Works; and
|
|
105
|
+
|
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
|
108
|
+
include a readable copy of the attribution notices contained
|
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
|
111
|
+
of the following places: within a NOTICE text file distributed
|
|
112
|
+
as part of the Derivative Works; within the Source form or
|
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
|
114
|
+
within a display generated by the Derivative Works, if and
|
|
115
|
+
wherever such third-party notices normally appear. The contents
|
|
116
|
+
of the NOTICE file are for informational purposes only and
|
|
117
|
+
do not modify the License. You may add Your own attribution
|
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
120
|
+
that such additional attribution notices cannot be construed
|
|
121
|
+
as modifying the License.
|
|
122
|
+
|
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
|
124
|
+
may provide additional or different license terms and conditions
|
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
128
|
+
the conditions stated in this License.
|
|
129
|
+
|
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
133
|
+
this License, without any additional terms or conditions.
|
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
135
|
+
the terms of any separate license agreement you may have executed
|
|
136
|
+
with Licensor regarding such Contributions.
|
|
137
|
+
|
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
140
|
+
except as required for reasonable and customary use in describing the
|
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
142
|
+
|
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
|
152
|
+
|
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
|
158
|
+
incidental, or consequential damages of any character arising as a
|
|
159
|
+
result of this License or out of the use or inability to use the
|
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
162
|
+
other commercial damages or losses), even if such Contributor
|
|
163
|
+
has been advised of the possibility of such damages.
|
|
164
|
+
|
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
168
|
+
or other liability obligations and/or rights consistent with this
|
|
169
|
+
License. However, in accepting such obligations, You may act only
|
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
174
|
+
of your accepting any such warranty or additional liability.
|
|
175
|
+
|
|
176
|
+
END OF TERMS AND CONDITIONS
|
|
177
|
+
|
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
179
|
+
|
|
180
|
+
To apply the Apache License to your work, attach the following
|
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
182
|
+
replaced with your own identifying information. (Don't include
|
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
184
|
+
comment syntax for the file format. We also recommend that a
|
|
185
|
+
file or class name and description of purpose be included on the
|
|
186
|
+
same "printed page" as the copyright notice for easier
|
|
187
|
+
identification within third-party archives.
|
|
188
|
+
|
|
189
|
+
Copyright 2026 Arqux Authors
|
|
190
|
+
|
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
192
|
+
you may not use this file except in compliance with the License.
|
|
193
|
+
You may obtain a copy of the License at
|
|
194
|
+
|
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
196
|
+
|
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
200
|
+
See the License for the specific language governing permissions and
|
|
201
|
+
limitations under the License.
|
arqux-1.0.0/MANIFEST.in
ADDED