Kamy
開発者向けのPDF生成API。請求書、領収書、契約書、レポートを美しいデフォルト設定で発行できます。
インストール
# SDK — in your app
npm i @kamydev/sdk
# CLI — globally for scripts, CI, previews
npm i -g @kamydev/cliimport Kamy from "@kamydev/sdk";
const kamy = new Kamy({ apiKey: process.env.KAMY_API_KEY! });
const pdf = await kamy.render({
template: "invoice",
data: { invoiceNumber: "INV-001", total: 1500, currency: "USD" },
});
console.log(pdf.url); // signed URL, valid 1 hour新着情報
日付 | 変更内容 | ||
2026年4月 |
| ||
2026年4月 | SDKにOpenAPI生成型が同梱されるようになりました。ライブ仕様から導出されたリクエスト/レスポンス形状の完全な型定義として | ||
2026年4月 | レンダリング時にAjvを使用したテンプレートごとのJSONスキーマ検証(フォーマット有効化済み)が導入されました。以前は | ||
2026年4月 |
| ||
2026年4月 | OpenAPI 3.0.3仕様が、全19の | ||
2026年4月 |
| ||
2026年4月 |
| ||
2026年4月 | `options.pdfA: "1b" | "2b" | "3b"` — 埋め込みsRGB ICC OutputIntent + XMPによるベストエフォート型のPDF/Aアーカイブタグ付け。 |
2026年4月 |
| ||
2026年4月 |
|
リリースの詳細は CHANGELOG.md を参照してください。
アーキテクチャ
KamyはTurborepoモノレポであり、以下を含みます:
パッケージ | 説明 |
| Next.js 15アプリ — ランディングページ、ダッシュボード、REST API |
| Cloudflare Worker — AIコーディングエージェント用MCPサーバー |
| Nextraドキュメントサイト |
|
|
|
|
|
|
|
|
|
|
前提条件
Node.js 22以上
pnpm 10以上
Supabase CLI (
brew install supabase/tap/supabase)Wrangler CLI (
pnpm add -g wrangler) — MCPサーバー用
ローカル開発
# 1. Install dependencies
pnpm install
# 2. Copy env file and fill in values
cp .env.example apps/web/.env.local
# 3. Start local Supabase (requires Docker)
supabase start
# 4. Apply database migrations
supabase db reset
# 5. Generate TypeScript types from schema
supabase gen types typescript --local > packages/shared/src/types/database.ts
# 6. Start all apps in dev mode
pnpm devWebアプリは https://kamy.dev で実行されます
コマンド
pnpm dev # Start all apps with Turbopack (hot reload)
pnpm build # Production build all apps
pnpm typecheck # TypeScript check across all packages
pnpm lint # Biome lint + format check
pnpm lint:fix # Biome auto-fix
pnpm test # Run all tests (Vitest unit + Playwright E2E)
pnpm test:unit # Vitest unit tests only
pnpm test:e2e # Playwright E2E tests only
pnpm clean # Remove all build artifactsデータベース
マイグレーションは supabase/migrations/ にあります。タイムスタンプ順に適用されます。
# Reset and reseed local DB
supabase db reset
# Create a new migration
supabase migration new <name>
# Push to remote Supabase project
supabase db pushデプロイ
Webアプリ:
mainへのマージ時にVercelへデプロイMCPサーバー:
wrangler deployを介してCloudflare Workersへデプロイデータベース: Supabase Cloudでホスト
環境変数
必要なすべての変数と説明については .env.example を参照してください。
技術スタック
フレームワーク: Next.js 15 (App Router, React Server Components, Turbopack)
言語: TypeScript 5.7+ strict
データベース: Supabase (Postgres 16 + Auth + Storage)
スタイリング: Tailwind CSS v4 (Oxideエンジン)
決済: Stripe (Meters API)
PDFエンジン: Browserless.io v2
メール: Resend + React Email
可観測性: Sentry + PostHog + Axiom
テスト: Vitest + Playwright + MSW
オープンプラグイン
このリポジトリは Open Plugins ディストリビューションを提供しており、AIコーディングエージェント(Cursor、Claude Code、その他Open-Plugins互換ツール)がKamyを単一のプラグインとしてインストールし、すぐに使えるPDFパイプラインを利用できるようにしています。
プラグインはリポジトリルートで4つのコンポーネントをバンドルしています:
パス | コンポーネント | 目的 |
| マニフェスト | 名前、バージョン、メタデータ、宣言されたコンポーネント |
| スキル | PDFをいつどのようにレンダリングするかをエージェントに教える |
| ルール |
|
| サブエージェント | 特化したテンプレート設計エージェント (Handlebars + print CSS) |
| MCPサーバー | レンダリングツールを公開する |
サポートされているエージェントにプラグインをインストールするには、このリポジトリ (https://github.com/rakanalalami/kamy) を指定し、ホストのプラグインインストールフローに従ってください。エージェントがマニフェストを読み取り、コンポーネントを自動的にロードします。
完全なスキーマについては Open Plugins仕様 を参照してください。
This server cannot be deployed
Related MCP Connectors
Hosted MCP server: convert PDFs to clean, LLM-ready Markdown with tables, formulas and OCR.
MCP server for Api2Pdf — generate PDFs & images from HTML, URLs or office files; merge, barcodes.
Turn a description into a shareable, editable PDF — invoices, certificates, reports, resumes.
Hosted MCP server for Anvil — fill & generate PDFs and run Etch e-signature packets for AI agents.
Related MCP Servers
- AlicenseAqualityCmaintenanceEnables creative PDF generation with full design control including colors, shapes, emoji, and Unicode support. Supports everything from simple documents to artistic masterpieces using PDFKit's powerful API.51,421 npm2MIT