agentbubble
v0.1.4
Published
Stop coding agents from wandering outside the ticket. A local task contract for Claude Code, Codex, and Cursor.
Maintainers
Readme
AgentBubble
Install
Run AgentBubble from the project you want to prepare:
npx agentbubble@latest init --adapter claudeUsing Codex instead:
npx agentbubble@latest init --adapter codexSupported adapters are claude, cursor, codex, generic, and none.
Quick Start
- Initialize local project guidance for your coding agent:
npx agentbubble@latest init --adapter claudeFill
.agentbubble/current-ticket.mdwith the current task, declared scope, expected domains, forbidden domains, risky systems, and acceptance criteria.Tell your coding agent: "Ticket is ready. Begin intake."
Audit changed files for scope drift risks before review:
npx agentbubble@latest auditWhat AgentBubble Does
AgentBubble creates a local .agentbubble/ folder that gives coding agents project-specific guidance before they start editing.
It helps you:
- capture project context and architecture notes
- write the active ticket in a consistent format
- point Claude Code, Codex, Cursor, or another agent at the same local guidance
- audit changed files against the ticket before review
AgentBubble is local-only. It does not install an agent runtime, hosted service, telemetry, model integration, or background automation.
Why AgentBubble Exists
Coding agents work better when they have clear context, explicit constraints, and a small task contract.
AgentBubble gives the agent a bounded place to start, then gives the human a quick audit of whether changed files match the declared scope.
Claude Code / Codex / Cursor Usage
Use the adapter that matches your coding agent:
npx agentbubble@latest init --adapter claudenpx agentbubble@latest init --adapter codexnpx agentbubble@latest init --adapter cursorAdapters write lightweight pointers for the selected tool. The .agentbubble/ folder remains the source of truth.
Commands
agentbubble init [--force] [--yes] [--adapter <claude|cursor|codex|generic|none>]
agentbubble auditagentbubble init creates .agentbubble/ in the current project, detects deterministic local project signals, and writes lightweight adapter pointers when requested.
agentbubble audit inspects changed files against .agentbubble/current-ticket.md and reports scope drift, risky changes, and clean changes.
How Audit Works
agentbubble audit requires a git repository, a baseline commit, and .agentbubble/current-ticket.md.
It checks changed files from:
- unstaged changes
- staged changes
- untracked files
It compares those files with the ticket sections:
Declared ScopeExpected DomainsForbidden DomainsRisky SystemsAcceptance Criteria
Example audit output:
Ticket Scope Audit
Declared scope:
- frontend/app/(app)/calendar/
Changed files:
1
Clean Changes: 1
No scope drift detected.Project Files Created
AgentBubble copies the base template into .agentbubble/:
context.md: product, architecture, rules, and known risksarchitecture.md: stack, directories, services, and commandscurrent-ticket.md: the active task contractsession-start.md: the bootstrap file agents read firstworkflow.md: the expected work loopcoding-rules.md: local coding constraintshuman-gates.md: places where the agent should stop for approvaldefinition-of-done.md: review and QA expectationssession-end.md: end-of-session handoff guidance
See install.md for the full install flow.
Philosophy
AgentBubble is a practical operating layer for human-directed agentic engineering.
Agents are powerful but stochastic. They can write useful code quickly, but they need clear boundaries, current context, and explicit acceptance criteria.
AgentBubble treats agent work as engineering work:
- preserve the existing architecture
- follow established patterns
- mutate the smallest necessary surface area
- avoid opportunistic refactors
- verify behavior before claiming completion
- audit the diff against the original ticket
The agent may implement, but it may not silently redefine the problem.
Context -> Ticket Understanding -> Plan -> Minimal Implementation -> Test -> Audit -> Fix -> QA-ReadyRepository Contents
philosophy.md: core operating modelcontext-factory.md: project context compressionticket-intake-loop.md: pre-implementation scope controlimplementation-loop.md: safe coding rulesaudit-loop.md: review and risk inspectiondefinition-of-done.md: QA and production readinessinstall.md: installation guideprompts/: copy-paste promptstemplates/: reusable specs, checklists, and base.agentbubble/filesskills/: tool-specific adapter guidanceassets/: launch and package media
Contributing
Contributions should keep AgentBubble focused on real init and audit workflows, deterministic local behavior, and scoped launch polish. See CONTRIBUTING.md.
