agentbrief 0.1.0

package/dist/types.d.ts

@@ -0,0 +1,61 @@
+export interface BriefSpec {
+    name: string;
+    version: string;
+    description?: string;
+    /** Relative path to personality markdown file. Default: "personality.md" */
+    personality?: string;
+    /** Scale / operational constraints */
+    scale?: ScaleConfig;
+    /** Relative paths to knowledge files or directories */
+    knowledge?: string[];
+    /** Relative paths to skill directories */
+    skills?: string[];
+    /** Extend other briefs — inherit their knowledge and skills */
+    extends?: string[];
+}
+export interface ScaleConfig {
+    concurrency?: number;
+    timeout?: number;
+    engine?: string;
+    model?: string;
+}
+export interface LockFile {
+    version: 1;
+    briefs: LockEntry[];
+}
+export interface LockEntry {
+    name: string;
+    source: string;
+    version: string;
+    ref?: string;
+    sha?: string;
+    applied_at: string;
+}
+export interface BriefSource {
+    type: "local" | "github" | "registry";
+    /** Absolute local path to the brief directory */
+    path: string;
+    /** Original source string as provided by user */
+    original: string;
+    ref?: string;
+    sha?: string;
+}
+export interface SkillMeta {
+    name: string;
+    description?: string;
+    /** Relative path to the skill file within the brief */
+    path: string;
+}
+export type TrustLevel = "official" | "verified" | "community";
+export interface RegistryEntry {
+    source: string;
+    description?: string;
+    trust: TrustLevel;
+}
+export type Registry = Record<string, RegistryEntry>;
+export type EngineTarget = "claude-code" | "cursor" | "opencode" | "codex";
+/** Maps engine name → instruction file path (relative to project root) */
+export declare const ENGINE_FILES: Record<EngineTarget, string>;
+/** Reverse mapping: instruction file → engine targets that use it */
+export declare const FILE_ENGINES: Record<string, EngineTarget[]>;
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAEA,MAAM,WAAW,SAAS;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,4EAA4E;IAC5E,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,sCAAsC;IACtC,KAAK,CAAC,EAAE,WAAW,CAAC;IACpB,uDAAuD;IACvD,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;IACrB,0CAA0C;IAC1C,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAClB,+DAA+D;IAC/D,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;CACnB;AAED,MAAM,WAAW,WAAW;IAC3B,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;CACf;AAID,MAAM,WAAW,QAAQ;IACxB,OAAO,EAAE,CAAC,CAAC;IACX,MAAM,EAAE,SAAS,EAAE,CAAC;CACpB;AAED,MAAM,WAAW,SAAS;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,MAAM,CAAC;IAChB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,UAAU,EAAE,MAAM,CAAC;CACnB;AAID,MAAM,WAAW,WAAW;IAC3B,IAAI,EAAE,OAAO,GAAG,QAAQ,GAAG,UAAU,CAAC;IACtC,iDAAiD;IACjD,IAAI,EAAE,MAAM,CAAC;IACb,iDAAiD;IACjD,QAAQ,EAAE,MAAM,CAAC;IACjB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,GAAG,CAAC,EAAE,MAAM,CAAC;CACb;AAID,MAAM,WAAW,SAAS;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,uDAAuD;IACvD,IAAI,EAAE,MAAM,CAAC;CACb;AAID,MAAM,MAAM,UAAU,GAAG,UAAU,GAAG,UAAU,GAAG,WAAW,CAAC;AAE/D,MAAM,WAAW,aAAa;IAC7B,MAAM,EAAE,MAAM,CAAC;IACf,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,KAAK,EAAE,UAAU,CAAC;CAClB;AAED,MAAM,MAAM,QAAQ,GAAG,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC;AAIrD,MAAM,MAAM,YAAY,GAAG,aAAa,GAAG,QAAQ,GAAG,UAAU,GAAG,OAAO,CAAC;AAE3E,0EAA0E;AAC1E,eAAO,MAAM,YAAY,EAAE,MAAM,CAAC,YAAY,EAAE,MAAM,CAKrD,CAAC;AAEF,qEAAqE;AACrE,eAAO,MAAM,YAAY,EAAE,MAAM,CAAC,MAAM,EAAE,YAAY,EAAE,CAIvD,CAAC"}

package/dist/types.js

@@ -0,0 +1,15 @@
+// ── Brief spec (brief.yaml) ─────────────────────────────
+/** Maps engine name → instruction file path (relative to project root) */
+export const ENGINE_FILES = {
+    "claude-code": "CLAUDE.md",
+    cursor: ".cursorrules",
+    opencode: "AGENTS.md",
+    codex: "AGENTS.md",
+};
+/** Reverse mapping: instruction file → engine targets that use it */
+export const FILE_ENGINES = {
+    "CLAUDE.md": ["claude-code"],
+    ".cursorrules": ["cursor"],
+    "AGENTS.md": ["opencode", "codex"],
+};
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,2DAA2D;AA8E3D,0EAA0E;AAC1E,MAAM,CAAC,MAAM,YAAY,GAAiC;IACzD,aAAa,EAAE,WAAW;IAC1B,MAAM,EAAE,cAAc;IACtB,QAAQ,EAAE,WAAW;IACrB,KAAK,EAAE,WAAW;CAClB,CAAC;AAEF,qEAAqE;AACrE,MAAM,CAAC,MAAM,YAAY,GAAmC;IAC3D,WAAW,EAAE,CAAC,aAAa,CAAC;IAC5B,cAAc,EAAE,CAAC,QAAQ,CAAC;IAC1B,WAAW,EAAE,CAAC,UAAU,EAAE,OAAO,CAAC;CAClC,CAAC"}

package/package.json

@@ -0,0 +1,64 @@
+{
+  "name": "agentbrief",
+  "version": "0.1.0",
+  "description": "Pluggable role definitions for AI coding agents",
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    }
+  },
+  "bin": {
+    "agentbrief": "./dist/cli.js"
+  },
+  "scripts": {
+    "build": "tsc",
+    "dev": "tsx src/cli.ts",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "lint": "biome check src/",
+    "lint:fix": "biome check --write src/",
+    "format": "biome format --write src/",
+    "prepublishOnly": "pnpm run build"
+  },
+  "dependencies": {
+    "commander": "^13.0.0",
+    "js-yaml": "^4.1.0"
+  },
+  "devDependencies": {
+    "@biomejs/biome": "^2.4.6",
+    "@types/js-yaml": "^4.0.9",
+    "@types/node": "^22.0.0",
+    "tsx": "^4.0.0",
+    "typescript": "^5.7.0",
+    "vitest": "^4.0.18"
+  },
+  "files": [
+    "dist",
+    "!dist/__tests__",
+    "templates",
+    "briefs",
+    "registry.yaml"
+  ],
+  "keywords": [
+    "ai",
+    "agent",
+    "role",
+    "persona",
+    "brief",
+    "claude-code",
+    "cursor",
+    "opencode",
+    "codex",
+    "coding-agent"
+  ],
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/0xranx/agentbrief"
+  },
+  "homepage": "https://github.com/0xranx/agentbrief#readme"
+}

package/registry.yaml

@@ -0,0 +1,91 @@
+# AgentBrief Official Registry
+#
+# Maps short names to GitHub sources.
+# Users can type `agentbrief use <name>` instead of the full GitHub path.
+#
+# Official briefs are bundled in the npm package (briefs/ directory) and
+# resolve locally without network access. The GitHub source below serves
+# as a fallback and canonical URL for reference.
+#
+# Trust levels:
+#   official  — Maintained by the AgentBrief team
+#   verified  — Community briefs reviewed and approved via PR
+#   community — Listed but not reviewed (shown with warning)
+
+# ── Development ──────────────────────────────────────────
+
+security-auditor:
+  source: github:0xranx/agentbrief/briefs/security-auditor
+  description: OWASP/CWE security review specialist
+  trust: official
+
+code-reviewer:
+  source: github:0xranx/agentbrief/briefs/code-reviewer
+  description: Rigorous PR review — naming, tests, architecture
+  trust: official
+
+typescript-strict:
+  source: github:0xranx/agentbrief/briefs/typescript-strict
+  description: TypeScript type safety guardian — zero any
+  trust: official
+
+nextjs-fullstack:
+  source: github:0xranx/agentbrief/briefs/nextjs-fullstack
+  description: Next.js 15 + App Router + React 19 + Tailwind
+  trust: official
+
+frontend-design:
+  source: github:0xranx/agentbrief/briefs/frontend-design
+  description: React + Tailwind + shadcn/ui design engineering
+  trust: official
+
+# ── Operations ───────────────────────────────────────────
+
+devops-sre:
+  source: github:0xranx/agentbrief/briefs/devops-sre
+  description: Infrastructure monitoring, incident response, IaC
+  trust: official
+
+tech-writer:
+  source: github:0xranx/agentbrief/briefs/tech-writer
+  description: Technical documentation with style guide adherence
+  trust: official
+
+# ── Business ─────────────────────────────────────────────
+
+growth-engineer:
+  source: github:0xranx/agentbrief/briefs/growth-engineer
+  description: CRO, SEO, analytics, growth engineering
+  trust: official
+
+product-manager:
+  source: github:0xranx/agentbrief/briefs/product-manager
+  description: PRD generation, user stories, prioritization
+  trust: official
+
+startup-builder:
+  source: github:0xranx/agentbrief/briefs/startup-builder
+  description: Idea validation → MVP → launch workflow
+  trust: official
+
+qa-engineer:
+  source: github:0xranx/agentbrief/briefs/qa-engineer
+  description: Automated QA — find bugs, write tests, fix with atomic commits
+  trust: official
+
+data-analyst:
+  source: github:0xranx/agentbrief/briefs/data-analyst
+  description: Business intelligence — metrics, SQL, dashboards, data storytelling
+  trust: official
+
+# ── Combo Packs ──────────────────────────────────────────
+
+fullstack-dev:
+  source: github:0xranx/agentbrief/briefs/fullstack-dev
+  description: Full-stack TypeScript developer — extends typescript-strict + nextjs + design + review
+  trust: official
+
+startup-kit:
+  source: github:0xranx/agentbrief/briefs/startup-kit
+  description: Startup builder kit — extends startup + product + growth + security
+  trust: official

package/templates/default/brief.yaml

@@ -0,0 +1,7 @@
+name: my-agent
+version: "0.1.0"
+description: My agent brief
+personality: personality.md
+knowledge:
+  - knowledge/
+skills: []

package/templates/default/personality.md

@@ -0,0 +1,12 @@
+## Role
+
+Describe the role and responsibilities of this agent.
+
+## Tone & Style
+
+Describe the communication style, tone, and language preferences.
+
+## Constraints
+
+- List behavioral constraints here
+- Things the agent must not do

package/templates/security/brief.yaml

@@ -0,0 +1,6 @@
+name: security-auditor
+version: "0.1.0"
+description: Security review specialist
+personality: personality.md
+knowledge:
+  - knowledge/

package/templates/security/personality.md

@@ -0,0 +1,20 @@
+## Role
+
+You are a security auditor. Review code changes for vulnerabilities using OWASP Top 10 and CWE classification.
+
+## Review Checklist
+
+- Injection flaws (SQL, NoSQL, OS command)
+- Broken authentication and session management
+- Sensitive data exposure
+- Broken access control
+- Security misconfiguration
+- Cross-Site Scripting (XSS)
+- Hardcoded secrets (API keys, passwords, tokens)
+
+## Constraints
+
+- Never approve code with known injection vectors
+- Always cite CWE identifiers in findings
+- Flag hardcoded credentials as Critical severity
+- When uncertain about severity, escalate