Skip to content
Back to search

Magic-Resume

Magic Resume is an open-source AI resume workbench: the AI proposes edits in place and you accept or skip each one. MIT-licensed core, 19 templates, six modes, cloud sync.

Safety scan

A static text scan, not a guarantee. Select the badge to see what was scanned and every finding.

Checked today
Badge for your README
findsafeskills safety rating

Markdown

[![findsafeskills safety rating](/api/listings/magic-resume--magic-resume/badge.svg)](/listings/magic-resume--magic-resume)

HTML

<a href="/listings/magic-resume--magic-resume"><img src="/api/listings/magic-resume--magic-resume/badge.svg" alt="findsafeskills safety rating" /></a>

Install

i

Install instructions from the README

As written by the repo's author. findsafeskills has not verified these steps.

Magic Resume runs fully in the browser — no backend, no database, no account.

git clone https://github.com/Magic-Resume/Magic-Resume.git
cd Magic-Resume
cp apps/web/.env.example apps/web/.env.local   # set NEXT_PUBLIC_APP_MODE=self-hosted
pnpm install
pnpm run dev

Open [http://localhost:3000](http://localhost:3000) and start building.

---

What was scanned

The files the safety scan read, as written by the repository's author and shown as plain text. Lines with a finding are marked.

README.md · README · 280 lines

View this file on GitHub (read at the repository's current version: the scan did not record which commit it read)

This file has changed since it was scanned, so this is not exactly the text that was scanned, and no line is marked. The findings are listed with the safety scan above.

  1. <div align="center">
  2. <a href="https://magic-resume.cn">
  3. <img width="112" alt="Kenmet" src="./apps/web/public/magic-resume-mark.png">
  4. </a>
  5. <h1>Kenmet</h1>
  6. <p><strong>An open-source resume editor with a self-hosted AI agent.</strong><br/>Your resumes stay in your browser. The AI runs on your own model key.</p>
  7. <p>
  8. <a href="#quick-start"><strong>Quick start</strong></a>
  9. &nbsp;·&nbsp;
  10. <a href="./README.zh-CN.md">简体中文</a>
  11. &nbsp;·&nbsp;
  12. <a href="https://magic-resume.cn">magic-resume.cn</a>
  13. &nbsp;·&nbsp;
  14. <a href="https://github.com/Magic-Resume/Magic-Resume/issues">Report an issue</a>
  15. </p>
  16. [![][github-stars-shield]][github-stars-link]
  17. [![][github-forks-shield]][github-forks-link]
  18. [![][github-contributors-shield]][github-contributors-link]
  19. [![][github-issues-shield]][github-issues-link]
  20. [![][github-license-shield]][github-license-link]
  21. </div>
  22. <br/>
  23. ![Polaris, the AI resume assistant: describe what to change, pick a skill, or choose the collaboration mode and model](./docs/images/readme/ai-lab.png)
  24. **Kenmet (formerly Magic Resume) is an open-source AI job-search workbench: the AI proposes resume edits in place and you accept or skip each one.** MIT-licensed core, 20 templates, six modes (create, optimize, analyze, translate, interview, export), cloud sync.
  25. > Kenmet (formerly Magic Resume, magic-resume.cn) and the Magic Resume at magicv.art (魔方简历) are two independent projects maintained by different teams.
  26. This repository is the open-source edition. It contains the editor and **Polaris**, the AI resume assistant, together with the agent service that powers it. There is no account and no resume library on a server: resumes and one conversation per resume live in your browser's IndexedDB, and Polaris calls the model provider you configure with your own key. Interviews and multi-device cloud sync are part of the hosted product at [magic-resume.cn](https://magic-resume.cn).
  27. <details>
  28. <summary><strong>Table of contents</strong></summary>
  29. - [Features](#features)
  30. - [Quick start](#quick-start)
  31. - [How Polaris works](#how-polaris-works)
  32. - [Configuration](#configuration)
  33. - [Open source and magic-resume.cn](#open-source-and-magic-resumecn)
  34. - [Repository layout](#repository-layout)
  35. - [Tech stack](#tech-stack)
  36. - [MCP](#mcp)
  37. - [Roadmap](#roadmap)
  38. - [Contributing](#contributing)
  39. - [License](#license)
  40. </details>
  41. ## Features
  42. ### Editor
  43. ![The editor: content on the left, a live print preview in the middle, template and layout controls on the right](./docs/images/readme/editor.png)
  44. - **Live preview at print fidelity.** The page re-renders as you type; exports match what you see.
  45. - **20 templates.** ATS-friendly, each with its own color, font, density, spacing and layout controls, on A4 or Letter.
  46. - **Flexible sections.** Add, rename, reorder and hide sections; rich text with Tiptap; custom fields.
  47. - **Import and export.** Open Kenmet JSON offline. Export to PDF, PNG or JSON.
  48. - **Local-first.** Everything is stored in IndexedDB. Nothing leaves the browser unless you use AI.
  49. - **Light and dark themes, English and Chinese.**
  50. ### Polaris
  51. - **Proposals, not overwrites.** Every change the AI makes appears as a diff on the canvas, with a reason for each edit. You accept or skip changes one by one; nothing is saved until you accept.
  52. - **Skills.** Create a resume from scratch, optimize it for a job description, analyze it, score its fit against a role, or translate it. Each skill is a plain Markdown file you can read and change.
  53. - **Three modes.** *Co-create* proposes edits, *Plan* reads the resume and proposes a plan without changing it, and *Ask* answers general questions without seeing your resume at all. The boundary is enforced by the backend, not only by the prompt.
  54. - **Asks when it needs to.** When a fact is missing, such as the target role, the agent shows a structured form, pauses, and continues once you answer. The pause survives a page reload or a server restart.
  55. - **Import any resume.** PDF, Word, images, Markdown or plain text. Scanned documents are read by a vision model.
  56. - **Your own model.** Any OpenAI-compatible API, with presets for common providers. The key is encrypted in the browser and sent only with each request; the server never stores it.
  57. - **No made-up experience.** The agent checks every proposed resume against your source material and flags employers, dates, credentials or numbers it cannot find there.
  58. ## Quick start
  59. ### Docker Compose (recommended)
  60. Runs the editor and the agent together. Requires Docker with Compose v2.
  61. ```bash
  62. git clone https://github.com/Magic-Resume/Magic-Resume.git
  63. cd Magic-Resume
  64. docker compose up --build
  65. ```
  66. Open [http://localhost:3000](http://localhost:3000), go to **Settings → Model**, choose a provider, enter your API key and model, test the connection and save. Polaris is then ready.
  67. The editor listens on `127.0.0.1:3000`. The agent has no published port and is reachable only from the editor container; its sessions are kept in the `agent-data` volume.
  68. ### Local development
  69. Requires Node.js 22.13 or later and pnpm 10.28.
  70. ```bash
  71. git clone https://github.com/Magic-Resume/Magic-Resume.git
  72. cd Magic-Resume
  73. pnpm install
  74. cp apps/web/.env.example apps/web/.env.local # then uncomment AI_BACKEND_URL=http://localhost:4000
  75. pnpm dev
  76. ```
  77. `pnpm dev` starts the editor on [http://localhost:3000](http://localhost:3000) and the agent on `http://127.0.0.1:4000`. Editing works without the agent; only Polaris needs it.
  78. To point the agent at a model server on your own machine or network (for example a local OpenAI-compatible proxy), start it with `AGENT_ALLOW_PRIVATE_MODEL_HOSTS=true`. This switch is ignored when `NODE_ENV=production`.
  79. ### Editor only
  80. The editor is a standard Next.js app and runs without the agent:
  81. ```bash
  82. docker build -f apps/web/Dockerfile -t magic-resume-web .
  83. docker run -p 3000:3000 magic-resume-web
  84. ```
  85. [![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2FMagic-Resume%2FMagic-Resume)
  86. To enable Polaris later, run the agent somewhere the editor can reach and set `AI_BACKEND_URL` on the editor.
  87. ## How Polaris works
  88. ```mermaid
  89. flowchart LR
  90. browser["Browser<br/>editor · IndexedDB"] -->|same-origin requests| web["Next.js routes<br/>apps/web"]
  91. web -->|AI_BACKEND_URL| agent["Agent<br/>apps/agent"]
  92. agent -->|your key| provider["Your model provider<br/>OpenAI-compatible API"]
  93. agent --- store[("SQLite<br/>session checkpoints")]
  94. ```
  95. - **The browser owns the resume.** Each request carries a snapshot of the current resume (except in Ask mode). The agent works on a draft and returns proposals; the browser saves what you accept. The draft lives only in the session's checkpoint and is deleted with it.
  96. - **The agent** (`apps/agent`) is a [DeepAgents](https://github.com/langchain-ai/deepagentsjs) harness on LangGraph with a Fastify HTTP layer. It mounts the skills directory read-only, gives the model a scratch workspace holding the resume draft, and runs a middleware chain that enforces the run budget, mode boundaries, each skill's tool allowlist, resume schema validation and the fabrication check.
  97. - **Sessions** are LangGraph checkpoints in SQLite, so a paused form, a page reload or a restart resumes where it left off. Idle sessions expire after seven days.
  98. - **Your key** stays in the request: it is never logged, written to a checkpoint or stored on disk. The agent resolves the provider's address once per request, pins the connection to it, refuses private network addresses and does not follow redirects.
  99. - **The protocol** between the editor and the agent is documented in [docs/reference/ai-backend.md](./docs/reference/ai-backend.md), and the agent's design in [docs/specs/agent-backend/design.md](./docs/specs/agent-backend/design.md). You can replace the agent with your own implementation of the same contract.
  100. > [!IMPORTANT]
  101. > The agent has no user accounts. Keep it on a private network, as Docker Compose does, or put authentication in front of it before exposing it to other people.
  102. ## Configuration
  103. Model settings (provider, key, base URL, model, output limit, reasoning strength) are configured per browser in **Settings → Model**. Server settings are environment variables; all are optional.
  104. <details>
  105. <summary><strong>Editor (<code>apps/web</code>)</strong></summary>
  106. <br/>
  107. | Variable | Default | Purpose |
  108. |---|---|---|
  109. | `AI_BACKEND_URL` | — | Server-only origin of the agent, without `/api`. AI requests return 503 when it is unset. |
  110. | `NEXT_PUBLIC_APP_URL` | `http://localhost:3000` | Public origin, used for `robots.txt` and page metadata. |
  111. | `APP_PUBLIC_URL` | — | Same as above, read at request time so one image can serve several domains. |
  112. | `NEXT_PUBLIC_DOCS_URL` | — | Target of the "Help center" menu item; hidden when unset. |
  113. </details>
  114. <details>
  115. <summary><strong>Agent (<code>apps/agent</code>)</strong></summary>
  116. <br/>
  117. | Variable | Default | Purpose |
  118. |---|---|---|
  119. | `HOST` / `PORT` | `127.0.0.1` / `4000` | Listen address. |
  120. | `AGENT_DATA_DIR` | `./data` | SQLite checkpoints and other runtime state. |
  121. | `AGENT_SKILLS_DIR` | bundled `skills/` | Directory of skills to mount. |
  122. | `AGENT_MAX_MODEL_CALLS` / `AGENT_MAX_TOOL_CALLS` | `40` / `60` | Budget per turn, shared with sub-agents. |
  123. | `AGENT_IDLE_TIMEOUT_MS` | `120000` | Longest silence from the model before a turn fails. |
  124. | `AGENT_RUN_TIMEOUT_MS` | `900000` | Upper bound for one turn. |
  125. | `AGENT_SESSION_TTL_HOURS` | `168` | Idle sessions are deleted after this. |
  126. | `AGENT_ATTACHMENT_TTL_HOURS` | `24` | Uploaded conversation files expire after this many hours. |
  127. | `AGENT_ATTACHMENT_SECRET` | random at startup | Optional stable HMAC secret, at least 32 characters; read URLs last up to 15 minutes. |
  128. | `AGENT_MAX_SEARCHES` | `5` | Search calls per turn, within the shared tool budget. |
  129. | `SEARCH_PROVIDER` | — | Optional `tavily`, `brave` or `searxng`; incomplete settings disable search and research skills. |
  130. | `SEARCH_API_KEY` | — | Required for Tavily and Brave. |
  131. | `SEARCH_BASE_URL` | provider default | Optional API base override; required for SearXNG, with no default public instance. Private hosts follow the model opt-in rule. |
  132. | `AGENT_BODY_LIMIT_BYTES` | `2097152` | Largest accepted JSON request. |
  133. | `AGENT_RATE_LIMIT_PER_MINUTE` | `300` | Requests per client address per minute; `0` disables the limit. |
  134. | `AGENT_ALLOW_PRIVATE_MODEL_HOSTS` | `false` | Allow model servers on private networks. Ignored in production. |
  135. See [`apps/agent/README.md`](./apps/agent/README.md) for the full list, how to write a skill, and a smoke test against a real model.
  136. </details>
  137. ## Open source and magic-resume.cn
  138. The editor and templates are the same; the hosted product runs the AI for you and adds accounts, sync and interviews.
  139. | | Open source (this repository) | magic-resume.cn |
  140. |---|---|---|
  141. | License | MIT | Free tier and paid plans |
  142. | Account | Not required | Required |
  143. | Resume storage | Your browser (IndexedDB) | Encrypted cloud storage, exportable at any time |
  144. | Multi-device sync | — | Yes |
  145. | AI | Polaris with your own model key, on the bundled agent | Managed models, mock interviews and memory |
  146. | Templates | 20 | 20 |
  147. ## Repository layout
  148. A pnpm and Turborepo monorepo. The shared schema, templates, design system, icons, utilities and the MCP server are published from [magic-resume-kit](https://github.com/Magic-Resume/magic-resume-kit) as `@magic-resume-kit/*` and pinned here by exact version.
  149. | Path | Description |
  150. |---|---|
  151. | `apps/web` | The editor and Polaris (Next.js) |
  152. | `apps/agent` | The agent behind Polaris (Fastify, DeepAgents, SQLite) |
  153. | `apps/agent/skills` | Skills and the agent's standing instructions, as Markdown |
  154. | `apps/landing` | Marketing site for magic-resume.cn (Astro) |
  155. | `apps/docs` | Documentation site (Mintlify) |
  156. | `packages/genui` | Polaris cards and widgets |
  157. | `packages/tsconfig` | Shared TypeScript configuration |
  158. ```bash
  159. pnpm dev # editor and agent
  160. pnpm build # build every workspace
  161. pnpm lint # lint and architecture checks
  162. pnpm test # tests
  163. pnpm --filter @magic-resume/agent test # one workspace
  164. ```
  165. ## Tech stack
  166. | Area | Technology |
  167. |---|---|
  168. | Editor | [Next.js 16](https://nextjs.org/), [React 19](https://react.dev/), [TypeScript](https://www.typescriptlang.org/), [Tailwind CSS 4](https://tailwindcss.com/), [Radix UI](https://www.radix-ui.com/), [Tiptap](https://tiptap.dev/), [Zustand](https://zustand-demo.pmnd.rs/), [i18next](https://www.i18next.com/) |
  169. | Documents | [React-PDF](https://react-pdf.org/), [PDF.js](https://mozilla.github.io/pdf.js/), [Zod](https://zod.dev/) schemas |
  170. | Agent | [DeepAgents](https://github.com/langchain-ai/deepagentsjs), [LangGraph](https://langchain-ai.github.io/langgraphjs/), [LangChain](https://js.langchain.com/), [Fastify](https://fastify.dev/), SQLite |
  171. | Tooling | [pnpm](https://pnpm.io/), [Turborepo](https://turbo.build/), ESLint, Docker |
  172. ## MCP
  173. [`@magic-resume-kit/mcp`](./docs/reference/mcp.md) is a Model Context Protocol server that lets AI coding tools such as Claude Code, Codex and Cursor read and edit resumes through schema-aware JSON Patch. It connects to a magic-resume.cn account; the local editor in this repository has no account API for it to reach.
  174. ```bash
  175. npx -y @magic-resume-kit/mcp@1.0.1 --help
  176. ```
  177. ## Roadmap
  178. - [x] Local-first editor with 20 templates
  179. - [x] Polaris on your own model key, with a self-hosted agent
  180. - [x] Resumable sessions, structured forms and approvals
  181. - [x] Import from PDF, Word, images and Markdown
  182. - [x] Attachments in conversations
  183. - [x] Optional web search with your own search API key, for company and role research
  184. Ideas and requests are welcome in [issues](https://github.com/Magic-Resume/Magic-Resume/issues).
  185. ## Contributing
  186. Contributions of every size are welcome: bug fixes, templates, skills, translations, docs and features. Read the [contributing guide](./CONTRIBUTING.md) for local setup, the branch workflow and the commit convention (gitmoji with Conventional Commits). For anything non-trivial, open an issue first to agree on the approach.
  187. <a href="https://github.com/Magic-Resume/Magic-Resume/graphs/contributors">
  188. <img src="https://contrib.rocks/image?repo=Magic-Resume/Magic-Resume" alt="Contributors" />
  189. </a>
  190. ## Star history
  191. <a href="https://star-history.com/#Magic-Resume/Magic-Resume&Date">
  192. <img src="https://api.star-history.com/svg?repos=Magic-Resume/Magic-Resume&type=Date" alt="Star history chart" width="600" />
  193. </a>
  194. ## License
  195. [MIT](./LICENSE) © 2026 [Kenmet Team](https://github.com/Magic-Resume)
  196. <!-- LINK GROUP -->
  197. [github-contributors-shield]: https://img.shields.io/github/contributors/Magic-Resume/Magic-Resume?color=c4f042&labelColor=black&style=flat-square
  198. [github-contributors-link]: https://github.com/Magic-Resume/Magic-Resume/graphs/contributors
  199. [github-forks-shield]: https://img.shields.io/github/forks/Magic-Resume/Magic-Resume?color=8ae8ff&labelColor=black&style=flat-square
  200. [github-forks-link]: https://github.com/Magic-Resume/Magic-Resume/network/members
  201. [github-stars-shield]: https://img.shields.io/github/stars/Magic-Resume/Magic-Resume?color=ffcb47&labelColor=black&style=flat-square
  202. [github-stars-link]: https://github.com/Magic-Resume/Magic-Resume/stargazers
  203. [github-issues-shield]: https://img.shields.io/github/issues/Magic-Resume/Magic-Resume?color=ff80eb&labelColor=black&style=flat-square
  204. [github-issues-link]: https://github.com/Magic-Resume/Magic-Resume/issues
  205. [github-license-shield]: https://img.shields.io/badge/license-MIT-white?labelColor=black&style=flat-square
  206. [github-license-link]: https://github.com/Magic-Resume/Magic-Resume/blob/master/LICENSE

Ratings and comments

Sign in to rate this skill.

Sign in

Free to use. If it’s helped, pass it on.