@greppleai/grip 0.0.0-stage → 0.0.1

package/examples/sdk/06-extensions.ts

@@ -0,0 +1,94 @@
+/**
+ * Extensions Configuration
+ *
+ * Extensions intercept agent events and can register custom tools.
+ * They provide a unified system for extensions, custom tools, commands, and more.
+ *
+ * By default, extension files are discovered from:
+ * - ~/.grip/agent/extensions/
+ * - <cwd>/.grip/extensions/
+ * - Paths specified in settings.json "extensions" array
+ *
+ * An extension is a TypeScript file that exports a default function:
+ *   export default function (pi: ExtensionAPI) { ... }
+ */
+
+import { DefaultResourceLoader, GripAgent, getAgentDir, InMemorySessionManager } from "@greppleai/grip";
+
+// Extensions are discovered automatically from standard locations.
+// You can also add paths via settings.json or DefaultResourceLoader options.
+
+const cwd = process.cwd();
+const agentDir = getAgentDir();
+const resourceLoader = new DefaultResourceLoader({
+	cwd,
+	agentDir,
+	additionalExtensionPaths: ["./my-logging-extension.ts", "./my-safety-extension.ts"],
+	extensionFactories: [
+		(pi) => {
+			pi.on("agent_start", () => {
+				console.log("[Inline Extension] Agent starting");
+			});
+		},
+	],
+});
+await resourceLoader.reload();
+
+const pi = await GripAgent.create({ cwd, agentDir, resourceLoader, sessionManager: new InMemorySessionManager() });
+const session = await pi.createAgentSession();
+
+try {
+	session.subscribe((event) => {
+		if (event.type === "message_update" && event.assistantMessageEvent.type === "text_delta") {
+			process.stdout.write(event.assistantMessageEvent.delta);
+		}
+	});
+
+	await session.prompt("List files in the current directory.");
+	console.log();
+} finally {
+	await pi.dispose();
+}
+
+// Example extension file (./my-logging-extension.ts):
+/*
+import type { ExtensionAPI } from "@greppleai/grip";
+
+export default function (pi: ExtensionAPI) {
+	pi.on("agent_start", async () => {
+		console.log("[Extension] Agent starting");
+	});
+
+	pi.on("tool_call", async (event) => {
+		console.log(\`[Extension] Tool: \${event.toolName}\`);
+		// Return { block: true, reason: "..." } to block execution
+		return undefined;
+	});
+
+	pi.on("agent_end", async (event) => {
+		console.log(\`[Extension] Done, \${event.messages.length} messages\`);
+	});
+
+	// Register a custom tool
+	pi.registerTool({
+		name: "my_tool",
+		label: "My Tool",
+		description: "Does something useful",
+		parameters: Type.Object({
+			input: Type.String(),
+		}),
+		execute: async (_toolCallId, params, _signal, _onUpdate, _ctx) => ({
+			content: [{ type: "text", text: \`Processed: \${params.input}\` }],
+			details: {},
+		}),
+	});
+
+	// Register a command
+	pi.registerCommand("mycommand", {
+		description: "Do something",
+		handler: async (args, ctx) => {
+			ctx.ui.notify(\`Command executed with: \${args}\`);
+		},
+	});
+}
+*/

package/examples/sdk/07-context-files.ts

@@ -0,0 +1,47 @@
+/**
+ * Context Files (AGENTS.md)
+ *
+ * Context files provide project-specific instructions loaded into the system prompt.
+ */
+
+import { DefaultResourceLoader, GripAgent, getAgentDir, InMemorySessionManager } from "@greppleai/grip";
+
+// Disable context files entirely by returning an empty list in agentsFilesOverride.
+const cwd = process.cwd();
+const agentDir = getAgentDir();
+const loader = new DefaultResourceLoader({
+	cwd,
+	agentDir,
+	agentsFilesOverride: (current) => ({
+		agentsFiles: [
+			...current.agentsFiles,
+			{
+				path: "/virtual/AGENTS.md",
+				content: `# Project Guidelines
+
+## Code Style
+- Use TypeScript strict mode
+- No any types
+- Prefer const over let`,
+			},
+		],
+	}),
+});
+await loader.reload();
+
+// Discover AGENTS.md files walking up from cwd
+const discovered = loader.getAgentsFiles().agentsFiles;
+console.log("Discovered context files:");
+for (const file of discovered) {
+	console.log(`  - ${file.path} (${file.content.length} chars)`);
+}
+
+const pi = await GripAgent.create({
+	cwd,
+	agentDir,
+	resourceLoader: loader,
+	sessionManager: new InMemorySessionManager(),
+});
+await pi.createAgentSession();
+console.log(`Session created with ${discovered.length + 1} context files`);
+await pi.dispose();

package/examples/sdk/08-prompt-templates.ts

@@ -0,0 +1,56 @@
+/**
+ * Prompt Templates
+ *
+ * File-based templates that inject content when invoked with /templatename.
+ */
+
+import {
+	createSyntheticSourceInfo,
+	DefaultResourceLoader,
+	GripAgent,
+	getAgentDir,
+	InMemorySessionManager,
+	type PromptTemplate,
+} from "@greppleai/grip";
+
+// Define custom templates
+const deployTemplate: PromptTemplate = {
+	name: "deploy",
+	description: "Deploy the application",
+	filePath: "/virtual/prompts/deploy.md",
+	sourceInfo: createSyntheticSourceInfo("/virtual/prompts/deploy.md", { source: "sdk" }),
+	content: `# Deploy Instructions
+
+1. Build: npm run build
+2. Test: npm test
+3. Deploy: npm run deploy`,
+};
+
+const cwd = process.cwd();
+const agentDir = getAgentDir();
+const loader = new DefaultResourceLoader({
+	cwd,
+	agentDir,
+	promptsOverride: (current) => ({
+		prompts: [...current.prompts, deployTemplate],
+		diagnostics: current.diagnostics,
+	}),
+});
+await loader.reload();
+
+// Discover templates from cwd/.grip/prompts/ and ~/.grip/agent/prompts/
+const discovered = loader.getPrompts().prompts;
+console.log("Discovered prompt templates:");
+for (const template of discovered) {
+	console.log(`  /${template.name}: ${template.description}`);
+}
+
+const pi = await GripAgent.create({
+	cwd,
+	agentDir,
+	resourceLoader: loader,
+	sessionManager: new InMemorySessionManager(),
+});
+await pi.createAgentSession();
+console.log(`Session created with ${discovered.length + 1} prompt templates`);
+await pi.dispose();

package/examples/sdk/09-api-keys-and-oauth.ts

@@ -0,0 +1,50 @@
+/**
+ * API Keys and OAuth
+ *
+ * Configure API key resolution via AuthStorage and ModelRegistry.
+ */
+
+import { AuthStorage, GripAgent, InMemorySessionManager, ModelRegistry } from "@greppleai/grip";
+
+interface AuthExampleOptions {
+	authStorage: AuthStorage;
+	modelRegistry: ModelRegistry;
+}
+async function createAuthExample(options: AuthExampleOptions) {
+	const pi = await GripAgent.create({
+		authStorage: options.authStorage,
+		modelRegistry: options.modelRegistry,
+		sessionManager: new InMemorySessionManager(),
+	});
+	await pi.createAgentSession();
+	return pi;
+}
+
+// Default: AuthStorage uses ~/.grip/agent/auth.json
+// ModelRegistry loads built-in + custom models from ~/.grip/agent/models.json
+const authStorage = AuthStorage.create();
+const modelRegistry = ModelRegistry.create(authStorage);
+
+const defaultAuthPi = await createAuthExample({ authStorage, modelRegistry });
+console.log("Session with default auth storage and model registry");
+await defaultAuthPi.dispose();
+
+// Custom auth storage location
+const customAuthStorage = AuthStorage.create("/tmp/my-app/auth.json");
+const customModelRegistry = ModelRegistry.create(customAuthStorage, "/tmp/my-app/models.json");
+
+const customAuthPi = await createAuthExample({ authStorage: customAuthStorage, modelRegistry: customModelRegistry });
+console.log("Session with custom auth storage location");
+await customAuthPi.dispose();
+
+// Runtime API key override (not persisted to disk)
+authStorage.setRuntimeApiKey("anthropic", "sk-my-temp-key");
+const runtimeKeyPi = await createAuthExample({ authStorage, modelRegistry });
+console.log("Session with runtime API key override");
+await runtimeKeyPi.dispose();
+
+// No models.json - only built-in models
+const simpleRegistry = ModelRegistry.inMemory(authStorage);
+const builtInModelsPi = await createAuthExample({ authStorage, modelRegistry: simpleRegistry });
+console.log("Session with only built-in models");
+await builtInModelsPi.dispose();

package/examples/sdk/10-settings.ts

@@ -0,0 +1,58 @@
+/**
+ * Settings Configuration
+ *
+ * Override settings using SettingsManager.
+ */
+
+import { GripAgent, InMemorySessionManager, SettingsManager } from "@greppleai/grip";
+
+const cwd = process.cwd();
+
+// Load current settings (merged global + project)
+const settingsManagerFromDisk = SettingsManager.create(cwd);
+console.log("Current settings:", JSON.stringify(settingsManagerFromDisk.getGlobalSettings(), null, 2));
+
+// Override specific settings
+const settingsManager = SettingsManager.create(cwd);
+settingsManager.applyOverrides({
+	enableSubagents: true,
+	compaction: { enabled: false },
+	retry: { enabled: true, maxRetries: 5, baseDelayMs: 1000 },
+});
+
+const customSettingsPi = await GripAgent.create({
+	cwd,
+	settingsManager,
+	sessionManager: new InMemorySessionManager(cwd),
+});
+await customSettingsPi.createAgentSession();
+console.log("Session created with custom settings");
+await customSettingsPi.dispose();
+
+// Setters update memory immediately and queue persistence writes.
+// Call flush() when you need a durability boundary.
+settingsManager.setDefaultThinkingLevel("low");
+await settingsManager.flush();
+
+// Surface settings I/O errors at the app layer.
+const settingsErrors = settingsManager.drainErrors();
+if (settingsErrors.length > 0) {
+	for (const { scope, error } of settingsErrors) {
+		console.warn(`Warning (${scope} settings): ${error.message}`);
+	}
+}
+
+// For testing without file I/O:
+const inMemorySettings = SettingsManager.inMemory({
+	compaction: { enabled: false },
+	retry: { enabled: false },
+});
+
+const testPi = await GripAgent.create({
+	cwd,
+	settingsManager: inMemorySettings,
+	sessionManager: new InMemorySessionManager(cwd),
+});
+await testPi.createAgentSession();
+console.log("Test session created with in-memory settings");
+await testPi.dispose();

package/examples/sdk/11-sessions.ts

@@ -0,0 +1,54 @@
+/**
+ * Session Management
+ *
+ * Control session persistence: in-memory, new file, continue, or open specific.
+ */
+
+import { GripAgent, InMemorySessionManager, LocalSessionManager } from "@greppleai/grip";
+
+const cwd = process.cwd();
+
+// In-memory (no persistence)
+const inMemoryPi = await GripAgent.create({ sessionManager: new InMemorySessionManager(cwd) });
+const inMemory = await inMemoryPi.createAgentSession();
+console.log("In-memory session:", inMemory.sessionReference ?? "(none)");
+await inMemoryPi.dispose();
+
+// New persistent session
+const newSessionManager = new LocalSessionManager({ cwd });
+const newSessionPi = await GripAgent.create({ cwd, sessionManager: newSessionManager });
+const newSession = await newSessionPi.createAgentSession();
+console.log("New session reference:", newSession.sessionReference);
+await newSessionPi.dispose();
+
+// Continue most recent session (or create new if none)
+const continuedSessionManager = new LocalSessionManager({ cwd });
+const continuedPi = await GripAgent.create({ cwd, sessionManager: continuedSessionManager });
+const continued = await continuedPi.createAgentSession({ session: continuedSessionManager.continueRecent() });
+if (continuedPi.modelFallbackMessage) console.log("Note:", continuedPi.modelFallbackMessage);
+console.log("Continued session:", continued.sessionReference);
+await continuedPi.dispose();
+
+// List and open specific session
+const sessions = await new LocalSessionManager({ cwd }).list();
+console.log(`\nFound ${sessions.length} sessions:`);
+for (const info of sessions.slice(0, 3)) {
+	console.log(`  ${info.id.slice(0, 8)}... - "${info.firstMessage.slice(0, 30)}..."`);
+}
+
+const sessionReference = sessions[0]?.reference;
+if (sessionReference) {
+	const openSessionManager = new LocalSessionManager({ cwd });
+	const openedPi = await GripAgent.create({ cwd, sessionManager: openSessionManager });
+	const opened = await openedPi.createAgentSession({ session: openSessionManager.openReference(sessionReference) });
+	console.log(`\nOpened: ${opened.sessionId}`);
+	await openedPi.dispose();
+}
+
+// Custom session directory (no cwd encoding)
+// const customDir = "/path/to/my-sessions";
+// const localSessions = new LocalSessionManager({ cwd, sessionDir: customDir });
+// const pi = await GripAgent.create({ cwd, sessionManager: localSessions });
+// const session = await pi.createAgentSession();
+// await localSessions.list();
+// localSessions.continueRecent();

package/examples/sdk/12-full-control.ts

@@ -0,0 +1,79 @@
+/**
+ * Full Control
+ *
+ * Replace everything - no discovery, explicit configuration.
+ */
+
+import {
+	AuthStorage,
+	createExtensionRuntime,
+	GripAgent,
+	InMemorySessionManager,
+	ModelRegistry,
+	type ResourceLoader,
+	SettingsManager,
+} from "@greppleai/grip";
+import { getModel } from "@greppleai/grip-ai";
+
+// Custom auth storage location
+const authStorage = AuthStorage.create("/tmp/my-agent/auth.json");
+
+// Runtime API key override (not persisted)
+if (process.env.MY_ANTHROPIC_KEY) {
+	authStorage.setRuntimeApiKey("anthropic", process.env.MY_ANTHROPIC_KEY);
+}
+
+// Model registry with no custom models.json
+const modelRegistry = ModelRegistry.inMemory(authStorage);
+
+const model = getModel("anthropic", "claude-sonnet-5");
+if (!model) throw new Error("Model not found");
+
+// In-memory settings with overrides
+const settingsManager = SettingsManager.inMemory({
+	compaction: { enabled: false },
+	retry: { enabled: true, maxRetries: 2 },
+});
+
+const cwd = process.cwd();
+
+const resourceLoader: ResourceLoader = {
+	getExtensions: () => ({ extensions: [], errors: [], runtime: createExtensionRuntime() }),
+	getSkills: () => ({ skills: [], diagnostics: [] }),
+	getRules: () => ({ rules: [], diagnostics: [] }),
+	getPrompts: () => ({ prompts: [], diagnostics: [] }),
+	getThemes: () => ({ themes: [], diagnostics: [] }),
+	getAgentsFiles: () => ({ agentsFiles: [] }),
+	getSystemPrompt: () => `You are a minimal assistant.
+Available: read, bash. Be concise.`,
+	getAppendSystemPrompt: () => [],
+	extendResources: () => {},
+	reload: async () => {},
+};
+
+const pi = await GripAgent.create({
+	cwd,
+	agentDir: "/tmp/my-agent",
+	model,
+	thinkingLevel: "off",
+	authStorage,
+	modelRegistry,
+	resourceLoader,
+	tools: ["read", "bash"],
+	sessionManager: new InMemorySessionManager(cwd),
+	settingsManager,
+});
+const session = await pi.createAgentSession();
+
+try {
+	session.subscribe((event) => {
+		if (event.type === "message_update" && event.assistantMessageEvent.type === "text_delta") {
+			process.stdout.write(event.assistantMessageEvent.delta);
+		}
+	});
+
+	await session.prompt("List files in the current directory.");
+	console.log();
+} finally {
+	await pi.dispose();
+}

package/examples/sdk/13-session-runtime.ts

@@ -0,0 +1,49 @@
+#!/usr/bin/env tsx
+/**
+ * Session replacement
+ *
+ * Use GripAgent when you need to replace the active AgentSession, for example
+ * for new-session, resume, fork, or import flows.
+ *
+ * The important pattern is: after GripAgent replaces the active session, rebind
+ * any session-local subscriptions and extension bindings to `pi.session`.
+ */
+
+import { GripAgent, LocalSessionManager } from "@greppleai/grip";
+
+const pi = await GripAgent.create({
+	cwd: process.cwd(),
+	sessionManager: new LocalSessionManager({ cwd: process.cwd() }),
+});
+
+let unsubscribe: (() => void) | undefined;
+
+async function bindSession() {
+	unsubscribe?.();
+	const session = pi.session;
+	await session.bindExtensions({});
+	unsubscribe = session.subscribe((event) => {
+		if (event.type === "queue_update") {
+			console.log("Queued:", event.steering.length + event.followUp.length);
+		}
+	});
+	return session;
+}
+
+await pi.createAgentSession();
+let session = await bindSession();
+const originalSessionReference = session.sessionReference;
+console.log("Initial session:", originalSessionReference);
+
+await pi.newSession();
+session = await bindSession();
+console.log("After newSession():", session.sessionReference);
+
+if (originalSessionReference) {
+	await pi.switchSession(originalSessionReference);
+	session = await bindSession();
+	console.log("After switchSession():", session.sessionReference);
+}
+
+unsubscribe?.();
+await pi.dispose();

package/examples/sdk/README.md

@@ -0,0 +1,94 @@
+# SDK Examples
+
+Programmatic usage of grip-coding-agent via `GripAgent`.
+
+`GripAgent` is the SDK composition root. It owns shared services, creates the active `AgentSession`, and manages session replacement flows.
+
+## Examples
+
+| File | Description |
+|------|-------------|
+| `01-minimal.ts` | Simplest usage with all defaults |
+| `02-custom-model.ts` | Select model and thinking level |
+| `03-custom-prompt.ts` | Replace or modify system prompt |
+| `04-skills.ts` | Discover, filter, or replace skills |
+| `05-tools.ts` | Built-in tool allowlists |
+| `06-extensions.ts` | Logging, blocking, result modification |
+| `07-context-files.ts` | AGENTS.md context files |
+| `08-prompt-templates.ts` | File-based prompt templates |
+| `09-api-keys-and-oauth.ts` | API key resolution, OAuth config |
+| `10-settings.ts` | Override compaction, retry, terminal settings |
+| `11-sessions.ts` | In-memory, persistent, continue, list sessions |
+| `12-full-control.ts` | Replace everything, no discovery |
+| `13-session-runtime.ts` | Manage runtime-backed session replacement |
+
+## Running
+
+```bash
+cd packages/coding-agent
+npx tsx examples/sdk/01-minimal.ts
+```
+
+## Quick Reference
+
+```typescript
+import { getModel } from "@greppleai/grip-ai";
+import {
+  AuthStorage,
+  DefaultResourceLoader,
+  InMemorySessionManager,
+  ModelRegistry,
+  GripAgent,
+  SettingsManager,
+} from "@greppleai/grip";
+
+const authStorage = AuthStorage.create();
+const modelRegistry = ModelRegistry.create(authStorage);
+
+const model = getModel("anthropic", "claude-opus-4-5");
+const loader = new DefaultResourceLoader({
+  systemPromptOverride: () => "You are helpful.",
+});
+await loader.reload();
+
+const gripAgent = await GripAgent.create({
+  authStorage,
+  modelRegistry,
+  model,
+  thinkingLevel: "high",
+  resourceLoader: loader,
+  tools: ["read", "bash", "edit", "write"],
+  sessionManager: new InMemorySessionManager(),
+  settingsManager: SettingsManager.inMemory(),
+});
+
+const session = await gripAgent.createAgentSession();
+session.subscribe((event) => {
+  if (event.type === "message_update" && event.assistantMessageEvent.type === "text_delta") {
+    process.stdout.write(event.assistantMessageEvent.delta);
+  }
+});
+await session.prompt("Hello");
+await gripAgent.dispose();
+```
+
+## Options
+
+Most one-off session options can be passed directly to `GripAgent.create()`:
+
+| Option | Default | Description |
+|--------|---------|-------------|
+| `authStorage` | `AuthStorage.create()` | Credential storage |
+| `modelRegistry` | `ModelRegistry.create(authStorage)` | Model registry |
+| `cwd` | `process.cwd()` | Working directory |
+| `agentDir` | `~/.grip/agent` | Config directory |
+| `sessionManager` | local JSONL manager | Session lifecycle backend |
+| `model` | From settings/first available | Model to use |
+| `thinkingLevel` | From settings/`"off"` | off, low, medium, high |
+| `tools` | `["read", "bash", "edit", "write"]` built-ins | Allowlist tool names across built-in, extension, and custom tools |
+| `customTools` | `[]` | Additional tool definitions |
+| `resourceLoader` | DefaultResourceLoader | Resource loader for extensions, skills, rules, prompts, themes |
+| `settingsManager` | SettingsManager.create(cwd, agentDir) | Settings source |
+| `resolveSessionOptions` | undefined | Per-session override hook for model, tools, and diagnostics |
+
+Use `gripAgent.createAgentSession({ session })` when you need to provide an already-created or opened `Session`.