Kami README

The project's README from github.com/tw93/Kami. As one markdown file: README.md.

Kami

Good content deserves good paper.

Stars Version License Twitter

Why

Kami gives AI agents templates and layout rules for documents and landing pages. Create PDFs and PNGs, or export slides as editable PowerPoint files.

Kami (紙, かみ) means paper in Japanese. It includes eight document templates, a landing-page system, and checks for content and layout.

Part of a trilogy: Kaku (書く) writes code, Waza (技) drills habits, Kami (紙) delivers documents.

Showcase

Sample PDFs in several formats and languages. Click any preview to open it.

Founder resume
Resume · English
Founder resume, 2 pages
Kami print one-pager
One-Pager · 中文
Kami 介绍 · 白底打印版
Tesla equity report
Equity Report · 中文
Tesla Q1 2026 财报点评
Agent keynote slides
Slides · English
Agent keynote, 8 slides
Mole product brief
One-Pager · English
Mole product brief, 1 page
Recommendation letter
Letter · 中文
推荐信, 1 页
Mole release notes
Changelog · English
Mole v1.7.1 release notes
Kaku portfolio
Portfolio · 日本語
Kaku ターミナル作品集 · 7 ページ

Install

Claude Code, Codex, Cursor, and other agents

npx skills add tw93/kami -a claude-code codex cursor -g -y

One copy lands in ~/.agents/skills, the shared skills directory. Claude Code is symlinked in; Codex, Cursor, and every other agent that reads that directory picks Kami up as /kami. Update with npx skills update -g -y.

Host plugin, if you prefer the host's own update command (namespaced as /kami:kami; Claude Code v2.1.142 or newer)

# Claude Code (update: claude plugin update kami)
/plugin marketplace add tw93/kami
/plugin install kami@kami

# Codex (update: codex plugin marketplace upgrade kami, then codex plugin add kami@kami)
codex plugin marketplace add tw93/kami
codex plugin add kami@kami

Claude Desktop: download the release asset kami.zip, not GitHub's source ZIP, open Customize > Skills > "+" > Create skill, and upload it. To update, click "..." on the skill card, choose Replace, and upload the latest ZIP.

Large CJK fonts stay out of every package: scripts/ensure-fonts.sh recovers missing Chinese or Korean fonts into the user font directory, and in a repository checkout it copies the tracked fonts into the skill so templates load them locally before falling back to the jsDelivr CDN.

Kami also runs a quiet version check at most once a day and tells you in chat when a newer published release is out. It writes a marker in the local XDG cache directory, then resolves GitHub's latest public release; it uploads no user document or task content and fails silently when offline or when no cache home is available.

Use

The skill auto-triggers from natural requests, no slash command needed. Optimized for English and Chinese; Japanese and Korean are supported via language-specific font fallbacks and layout adjustments, with output checked individually.

Example prompts by language:

Brand profile (optional)

Create ~/.config/kami/brand.md to persist identity, brand, defaults, and writing habits. See brand.example.md for a full template.

The file has YAML frontmatter for structured fields like name, role, email, brand color, language, page size, and tone, plus a Markdown body for freeform notes. Kami uses these settings where the current request leaves a choice open; explicit instructions always take priority. Use it to avoid repeating your preferences for each document.

Design

The defaults are a warm parchment background (#f5f4ed), ink-blue accents (#1B365D), and serif fonts. Templates use type size and spacing to separate titles, body text, and notes. You can adjust the defaults for your brand.

Kami picks the right variant based on the language you write in.

Fonts: Each language uses a single serif font for the entire page. Chinese: TsangerJinKai02. Japanese: YuMincho. Korean: Source Han Serif K. English: Charter. See License for font terms.

Full spec: design.md. Cheatsheet: CHEATSHEET.md.

Beyond Documents

The same layout rules also work for landing pages and prompts for AI image tools.

Kami landing page
Kami · landing page
Design system homepage
Mole landing page
Mole · landing page
macOS system utility
SpatialVLA architecture redraw
Architecture redraw · English
SpatialVLA Figure 1, schematic
Tesla Optimus patent overview
Evidence layout · 中文
Tesla Optimus 专利图一览

Landing pages ship as deployable multilingual sites. Illustrations use the host's own image generation when that capability is available; otherwise Kami outputs the same complete brief for use in an image model.

Redraw this as a clean editorial diagram. Background: warm parchment (#f5f4ed), never pure white. One accent only, ink blue (#1B365D); everything else in warm gray with a yellow-brown undertone, no other colors. Thin single-line geometric strokes and simple flat icons. No gradients, no drop shadows, no 3D. Labels in a serif typeface. Generous whitespace, calm and composed, like a figure in a well-typeset report.

Rendered by ChatGPT Images in a single pass with no manual touch-up. Kami specifies, the renderer draws.

Background

I like investing in US equities and ask Claude to write research reports all the time. Every output landed in the same default-doc look: gray, flat, a different layout each session. The structure was hard to scan, the formatting felt dated, and nothing about the page made me want to keep reading. So I started fixing the typography, the palette, the spacing, one rule at a time, until the report became a page I actually enjoyed.

Later I needed to present "The Agent You Don't Know: Principles, Architecture and Engineering Practice." I already had the document and didn't want to build slides from scratch, so I used Claude Design to lay it out in my own style, tweaked it round after round, and eventually got it to a place I was happy with. That process added inline SVG charts, a unified warm palette, and a tighter editorial rhythm. It kept growing until it covered every document I regularly ship, so I collected the templates and rules into Kami.

Support

These lovely people already did 🐱

License

MIT License for kami code and templates. Feel free to use and contribute.

Fonts: TsangerJinKai02 is free for personal use only; commercial use requires a license from tsanger.cn. Charter, YuMincho, Source Han Serif K under OFL, and CJK fallbacks are system-bundled or open-licensed.

Kami (tw93/Kami)

Searching Database…

12K ·GitHub
这是什么?Kami 是一个智能体技能(agent skill),能让 AI 编程代理(Claude Code、Codex、Cursor 等)借助模板和排版规则,把普通请求变成精致的文档和落地页,可输出 PDF、PNG,或可编辑的 PowerPoint 幻灯片。
这是我要运行的应用,还是 AI 代理使用的技能?它不是一个单独运行的应用,而是一个技能包,包含模板、脚本和一个小型 MCP 服务器。它会被放入你代理的共享技能文件夹中,当你请求生成文档时自动触发,无需斜杠命令。
怎么安装 Kami?用 'npx skills update -g -y' 安装,它会在共享的 ~/.agents/skills 目录中放入一份副本。Claude Code、Codex、Cursor 及其他能读取技能的代理会自动识别它,并以 /kami 的形式调用。Claude Desktop 用户则需改为下载 kami.zip 发布文件,然后在 Customize > Skills 中上传。
它需要哪些代理和工具才能运行?需要支持技能的 AI 代理(Claude Code、Codex、Cursor、Claude Desktop,或任何支持 MCP 的代理)。PDF 渲染默认使用 WeasyPrint,可编辑幻灯片的导出由 python-pptx 处理,Pygments 为可选项,用于代码语法高亮。
字体或授权方面有什么需要注意的吗?大型中日韩(CJK)字体没有内置,需要通过 scripts/ensure-fonts.sh 恢复。默认中文字体 TsangerJinKai02 仅限个人免费使用;如用于商业用途,需从 tsanger.cn 获取商业授权。
Kami 会把我的文档发送到别处吗?不会。它每天的版本检查只会在本地写入一个标记,并查询 GitHub 公开的发布信息;它从不上传文档或任务内容,离线时会静默失败。
Kami 开箱即用包含哪些模板?八种文档模板:One-Pager、Long Doc、Letter、Portfolio、Resume、Slides、Equity Report 和 Changelog,另有一套落地页系统,提供英文、中文和韩文版本。
它能画图,而不只是文字吗?可以。它内置十八种 SVG 图表类型;时序图、类图和 ER 图可以用 Mermaid 文本编写,并会自动换成 Kami 的暖色调配色。
作者为什么要自己做 Kami,而不直接用 AI 默认生成的文档?作者厌倦了 AI 生成的研究报告和幻灯片总是灰暗、扁平,而且每次会话的排版都不一样,于是制定了可复用的字体排印、配色和排版规则,并将其打包成 Kami。
和 Kami 一起提到的 Mole 是什么?Mole 是作者另外开发的付费 Mac 清理应用,与 Kami 一同推广。Kami 还是三部曲的一部分,另外两部分是 Kaku(负责写代码)和 Waza(负责培养习惯)。
Creator
tw93
Size
180.3 MB
Stars
12K
Age
5mo
Commits · 90 Days