@getripple/core
v1.0.9
Published
Core engine for Ripple's local authorization gate: context planning, drift checks, and trust boundaries.
Downloads
859
Maintainers
Readme
@getripple/core
Core engine for Ripple's local authorization gate for AI coding agents.
@getripple/core scans repositories, builds local dependency intelligence, tracks architectural relationships, records approved work boundaries, compares those boundaries against Git diffs, and powers Ripple's CLI, MCP server, CI integrations, and editor experiences.
Most users should start with:
@getripple/clior
@getripple/mcpand use @getripple/core only when building custom integrations.
Install
npm install @getripple/coreBasic Usage
import { GraphEngine } from "@getripple/core";
const engine = new GraphEngine(process.cwd());
try {
await engine.initialScan();
const blastRadius = engine.blastRadius(["src/auth.ts"]);
const importers = engine.downstreamFiles("src/auth.ts");
const imports = engine.upstreamFiles("src/auth.ts");
console.log({
blastRadius,
importers,
imports,
});
} finally {
engine.dispose();
}What Core Powers
@getripple/core is the shared engine behind Ripple's public interfaces.
@getripple/cli
@getripple/mcp
VS Code integrations
CI workflows
Custom integrationsThe engine provides local signals used to answer:
What should an agent read before editing?
What files may be affected?
What symbols may be affected?
What was approved?
What changed?
Did the agent cross the approved boundary?
Can the agent continue?
Does a human need to review?Core Capabilities
Ripple builds and maintains local repository intelligence.
dependency graph
reverse imports
exported symbols
call relationships
blast radius analysis
architectural history
focused context generation
saved change intents
approval tracking
trust-boundary validation
drift detection
authorization gate summariesThese capabilities power the Ripple workflow:
policy defines sensitive areas
intent defines what is approved now
Git diff shows what actually changed
gate decides continue, repair, or human reviewTrust Boundary Contract / Authorization Gate Contract
The Trust Boundary Contract is the core safety model used throughout Ripple. It defines what an AI coding agent is authorized to change for the current task.
The Authorization Gate Contract is the decision layer built from that trust boundary. It compares the approved boundary with the actual Git diff and decides whether work may continue, must be repaired, or needs human review.
Ripple compares:
approved intentagainst:
actual Git diffto determine whether an AI coding agent stayed inside the work it was trusted to perform.
The contract consists of:
policy -> permanent repo trust rules
intent -> temporary approved boundary for the current task
approved boundary -> file, function, task, brainstorm, or PR scope
actual changes -> what the agent modified
drift result -> whether the agent left the approved work
gate decision -> continue, repair, human-review, or restore-readinessTogether, the Trust Boundary Contract and Authorization Gate Contract enable Ripple to:
detect intent drift
detect boundary drift
detect policy drift
track verification evidence
require repair
require human review
produce continue/stop decisions
protect approved workflowsThis contract is consumed by:
humans
AI coding agents
CI systems
automation pipelinesRipple does not silently delete code. It gives the surrounding CLI, MCP, hook, or CI layer enough evidence to decide whether work may continue or must stop for repair or human review.
Context Modes
Core supports multiple context-generation modes.
leanUses graph and history cache for fast checks and gates.
on-demandBuilds targeted context for MCP tools and focused requests.
fullGenerates broader workflow context for file-oriented agent workflows.
Ripple Workspace
Machine cache:
.ripple/.cache/Workflow and audit state:
.ripple/policy.json
.ripple/history.json
.ripple/intents/
.ripple/approvals/Language Support
| Language | Support | | ---------- | ------- | | JavaScript | Deep | | TypeScript | Deep | | Python | Basic |
JavaScript and TypeScript currently provide the strongest experience.
Python support includes:
imports
functions
classes
basic call relationshipsFramework detection and configuration analysis remain heuristic.
Ripple reports local repository signals rather than perfect semantic truth.
Privacy
Ripple operates locally.
No telemetry
No cloud indexing
No code upload
No remote dependency required
No account requiredRepositories are scanned on the user's machine.
Status
Public alpha.
The most stable public contracts are:
@getripple/cli
@getripple/mcpCore APIs may evolve as Ripple's graph, context, authorization-gate, and approval systems mature.
What Core Is Not
@getripple/core is not:
a coding agent
a code generator
a code review replacement
a test replacement
a typechecker replacement
a sandbox
a compilerInstead, it is the local intelligence engine that helps Ripple determine whether an AI coding agent remained inside the work it was authorized to perform.
License
MIT
