Guide · Open source
How to use Kami: install the agent skill and export PDF, PNG or PPTX
Updated · written with AI from the project's own documentation and checked against our catalogue data
Kami is an open-source set of layout rules and document templates that AI coding agents can use to produce styled documents. You ask your agent for a one-pager, letter, resume, report or slide deck, and Kami helps it output a PDF, PNG or editable PowerPoint file. This guide covers installing the skill, the requests you can make, the supported languages and the limits to know before you start.
Quick start
- 1Check your agent. Confirm you use an AI agent that supports skills, such as Claude Code, Codex or Cursor.
- 2Install the skill. Run npx skills add tw93/kami -a claude-code codex cursor -g -y in your terminal.
- 3Make a request. Ask your agent in plain language for a one-pager, resume, letter, report or slide deck.
- 4Optionally add a brand profile. Create ~/.config/kami/brand.md with your name, colour and language preferences.
- 5Pick the output format. Ask for PDF, PNG or editable PowerPoint in your request.
- 6Update when needed. Run npx skills update -g -y to get the latest skill.
What Kami does and who it is for
Kami is a skill for AI agents. It gives the agent layout rules and templates for PDF, PNG and editable PowerPoint output. The README describes eight built-in document templates plus a landing page system.
It suits people who already use Claude Code, Codex or Cursor and want polished documents without manual layout work, as well as writers or founders who need one-pagers, resumes or formal letters in a consistent style.
- One-Pager, Long Doc, Letter, Portfolio, Resume, Slides, Equity Report and Changelog templates
- A Landing Page system, in English, Chinese and Korean
- Support for English, Chinese, Japanese and Korean
Install Kami for Claude Code, Codex and Cursor
The main install method is the skills package manager. You need an AI agent that supports skills, such as Claude Code, Codex or Cursor. Run the command below from the README to install the skill for all three agents.
The README says one copy lands in the shared skills directory, and Claude Code is symlinked to it. Codex, Cursor and other agents that read that directory pick Kami up as /kami. To update later, run the update command.
npx skills add tw93/kami -a claude-code codex cursor -g -y
npx skills update -g -yAsk your agent for a document
Kami triggers from natural requests, so you do not need a slash command. Describe the document you want in plain language. The README lists example prompts in each supported language.
The README says the agent picks the right template variant based on the language you write in. Describe the audience and purpose where you can, because the README notes that a structured brief records the audience and requirements.
- English: make a one-pager for my startup
- English: build me a resume
- English: write a formal letter
- Chinese: 帮我做一份简历
- Japanese: 履歴書を作って
- Korean: 이력서를 만들어줘
Set up a brand profile (optional)
You can create ~/.config/kami/brand.md to store your name, role, brand colour, language, page size and tone, so you do not repeat preferences for each document. Add freeform notes in the Markdown body.
Kami uses these settings where the current request leaves a choice open. Explicit instructions in your request always take priority. The repository includes skills/kami/references/brand.example.md as a full template.
~/.config/kami/brand.mdFonts, languages and Windows notes
English and Chinese have complete support. Japanese and Korean use language-specific font fallbacks and layout adjustments, with each output checked before delivery. Each language uses one serif font for the whole page.
Large CJK fonts are not in the packages. The helper script ensure-fonts.sh recovers missing Chinese or Korean fonts into the user font directory. On Windows, the README says to run Kami inside WSL (Ubuntu), because the helper scripts are Bash and WeasyPrint on native Windows needs GTK/Pango installed separately.
- English default serif: Charter
- Chinese default serif: TsangerJinKai02 (仓耳今楷)
- Japanese default serif: YuMincho (游明朝)
- Korean default serif: Source Han Serif K (本明朝)
skills/kami/scripts/ensure-fonts.shChoose the output format
By default, slides render through WeasyPrint HTML to PDF. For editable PowerPoint, ask for it, since the README says python-pptx handles PPTX on request. For Markdown-first decks, the README describes a Marp variant in skills/kami/assets/templates/marp/.
Code blocks get Pygments syntax highlighting when Pygments is installed. Without it, PDFs still render but code stays monochrome.
- PDF: WeasyPrint, the default for slides and documents
- PPTX: python-pptx, on request, for editable slides
- Marp: Markdown-first slide decks
What people use it for
- A one-page product brief for a startup
- A resume or formal recommendation letter in a consistent style
- A technical changelog rendered as a clean PDF
- A multi-page portfolio of your projects
- A slide deck for a talk, in editable PowerPoint or as Marp Markdown
- Chinese, Japanese or Korean documents that need proper font handling
Frequently asked questions
Is Kami free to use?
The repository is licensed under MIT, as shown in the README badge and project metadata. The README does not list any paid tier, so check the LICENSE file in the repository for the full terms.
What do I need to install Kami?
You need an AI agent that supports skills, such as Claude Code, Codex or Cursor. Kami is designed to be triggered by agent requests, so it does not work as a standalone editor.
Can I use Kami on Windows?
The README recommends running Kami inside WSL (Ubuntu). The helper scripts are Bash, and WeasyPrint on native Windows needs the GTK/Pango runtime installed separately.
How do I update Kami?
If you installed with the skills package manager, run npx skills update -g -y. The README also documents update commands for the Claude Code and Codex host plugins.
Does Kami support Chinese, Japanese and Korean?
Yes. English and Chinese have the most complete support. Japanese and Korean use language-specific font fallbacks and layout adjustments, and the README says each output is checked before delivery.
How does Kami compare to Marp, Pandoc, Typst or WeasyPrint?
Those are listed as comparable projects in our analysis. Kami is different because it works through an AI agent and ready-made templates, while the others are usually run directly from the command line or as document tools. Choose based on whether you want agent-driven layouts or direct control over the source.
New agent skills, repos and AI tools — every week
The best new skills and open-source projects, the fastest-growing repos, and one free prompt. Five minutes to read. Unsubscribe anytime.
Our verdict
Kami suits people who already use an AI agent such as Claude Code, Codex or Cursor and want consistent, polished documents with CJK font handling. If you need pixel-level control in a visual editor, or you cannot run an AI agent, pick a visual editor or a document tool such as Typst or Pandoc instead.
Install options & downloads