Skip to content

CLAUDE.md

Latest commit

 

History

History
81 lines (59 loc) · 2.34 KB

CLAUDE.md

File metadata and controls

81 lines (59 loc) · 2.34 KB

Interf CLI

Open-source CLI for the Enterprise Readiness Protocol. Published as interf on npm.

Project

  • Package: interf (npm, unscoped)
  • Repo: github.com/interf-labs/cli
  • Protocol repo: github.com/interf-labs/enterprise-readiness-protocol
  • License: MIT
  • Company: Interf, Inc. (interf.com)

Architecture

Skills-based CLI — installs SKILL.md files to coding agents (Claude Code, Codex, Cursor, Goose) that teach them how to draft readiness contracts and preview enterprise rollouts.

No Agent SDK dependency. No network calls. No code execution.

Key directories

  • src/ — TypeScript source (commands, lib)
  • protocol/ — Git submodule of enterprise-readiness-protocol (skills + canonical types)
  • dist/ — Compiled output (generated by npm run build)

Skills (installed from protocol submodule)

Skill Purpose
interf-draft Draft a readiness contract (interf.yaml)
interf-preview Preview enterprise rollout against company profiles
enterprise-readiness-protocol Protocol spec + canonical dependency types

Commands

Command Status
npx interf Install all skills to detected agents
interf validate Validate interf.yaml (schema + canonical types)
interf publish Publish to registry (coming soon)
interf preview Cloud-powered preview (coming soon)

Contract format (interf.yaml)

name: project-name
version: 0.1.0
description: What it does

requirements:
  - what: Plain English — what you need
    ready: How enterprise verifies it's done

optional:
  - what: Nice-to-have dependency
    ready: How to verify

Stack

  • TypeScript (ES2022, NodeNext)
  • yargs (CLI framework)
  • zod (schema validation)
  • yaml (parsing)
  • chalk (output formatting)
  • vitest (testing)

Commands

npm run build       # Compile TypeScript (auto-syncs canonical types)
npm test            # Run tests
npm publish         # Build + publish to npm

Conventions

  • Keep dependencies minimal (4 production deps)
  • Skills are the primary interface — the CLI installs them, agents use them
  • Skills follow Vercel Skills format (SKILL.md with YAML frontmatter)
  • Canonical types auto-generated from protocol submodule at build time
  • Terminology: "draft" (user action), "readiness contract" (artifact), "enterprise readiness" (the outcome)