# Magic Resume

> Magic Resume — the open-source, AI-native resume platform. A friendly usage guide for everyone, and a developer handbook for contributors and integrators.

## User Guide

### Get started

- [Welcome to Magic Resume](https://docs.magic-resume.cn/en/guide/index.md): Build a professional resume with AI — start without signing up, and your data stays in your own browser by default.
- [Your first resume in 3 minutes](https://docs.magic-resume.cn/en/guide/quickstart.md): The fastest path — open the app → create → fill in → export a PDF. No sign-up required.
- [Account & cloud sync](https://docs.magic-resume.cn/en/guide/account.md): When you actually need to sign in, and what it unlocks — multi-device sync, sharing, more AI quota.

### Your resume

- [Create / import a resume](https://docs.magic-resume.cn/en/guide/create-import.md): Start one from scratch, or import an existing PDF or JSON resume (PDFs are parsed automatically with AI).
- [Using the editor](https://docs.magic-resume.cn/en/guide/editor.md): Get to know the "form on the left, live preview on the right" editor — fill content, add/remove sections, reorder, show or hide.
- [Templates & styling](https://docs.magic-resume.cn/en/guide/templates.md): Pick a better-looking template, switch single/two-column, tweak fonts and colors — the look changes, your content doesn't.
- [Preview & export PDF](https://docs.magic-resume.cn/en/guide/export.md): Edit against a live preview, then export a high-quality PDF in one click, ready to send.

### AI Lab

- [What is AI Lab](https://docs.magic-resume.cn/en/guide/ai-lab.md): Meet Polaris (北极星), the AI Lab assistant — edit your resume in place through conversation, with every change proposed first and rejectable. It's the entry point to every AI capability.
- [Create a resume from scratch](https://docs.magic-resume.cn/en/guide/ai-create.md): No resume yet? Let AI build a first draft through a friendly Q&A, then refine.
- [Tailor to a job](https://docs.magic-resume.cn/en/guide/ai-optimize.md): Paste a target JD, company, and role, and let AI reshape your resume to fit — every change proposed first and rejectable.
- [Deep analysis (resume health check)](https://docs.magic-resume.cn/en/guide/ai-analyze.md): Have three virtual interviewers score your resume — overall score, attribute matrix, strengths and gaps, and an optimization roadmap.
- [Translate your resume](https://docs.magic-resume.cn/en/guide/ai-translate.md): Translate the whole resume into English, Japanese, Korean, French, and more — structure and layout preserved, only the language changes.
- [Mock interview](https://docs.magic-resume.cn/en/guide/ai-interview.md): Run a round of Q&A based on the experience in your resume — practice ahead of time and spot the gaps.

### Collaboration & sync

- [Cloud sync](https://docs.magic-resume.cn/en/guide/cloud-sync.md): Sign in and enable cloud sync — your resumes are stored in the cloud, synced across devices, with every version backed up.
- [Share & comments](https://docs.magic-resume.cn/en/guide/share-feedback.md): Generate a public link so others can drop comments right on your resume — and you can see and reply to them.
- [Version history](https://docs.magic-resume.cn/en/guide/history.md): Every change is tracked, so you can look back or restore an earlier version anytime — no fear of breaking things.
- [Notifications](https://docs.magic-resume.cn/en/guide/notifications.md): Get alerted here when someone comments or replies on a resume you shared.

### Advanced

- [Settings: AI & access tokens](https://docs.magic-resume.cn/en/guide/settings.md): Configure your own AI model (bring-your-own-key), toggle cloud sync, and create personal access tokens (PATs) for AI tools.
- [Connect AI coding tools (MCP)](https://docs.magic-resume.cn/en/guide/mcp.md): Advanced — read and edit your Magic Resume resumes right inside Claude Code, Cursor, and similar tools.
- [Job-search knowledge (Recruiting Timeline)](https://docs.magic-resume.cn/en/guide/knowledge.md): See each company's campus / internship recruiting timeline so you don't miss the application window.
- [Subscription & billing](https://docs.magic-resume.cn/en/guide/pricing.md): What the free tier does, what paid adds, and where to upgrade.

## Developer Handbook

### Introduction

- [Introduction](https://docs.magic-resume.cn/en/introduction.md): Magic Resume is an open-source, AI-native resume platform — a Turborepo frontend plus a NestJS backend behind a single gateway. This is the contributor & integrator handbook.

### Self-hosting & deployment

- [Getting Started](https://docs.magic-resume.cn/en/getting-started/index.md): Pick a path — run locally with no backend, or deploy with Clerk auth and cloud sync.
- [Self-Hosted](https://docs.magic-resume.cn/en/getting-started/self-hosted.md): Run Magic Resume on your own machine with no backend, no database, and no account.
- [Cloud Mode](https://docs.magic-resume.cn/en/getting-started/cloud.md): How cloud mode wires Clerk, the Core API, and the agent backend into Magic Resume.
- [Deploy to Vercel](https://docs.magic-resume.cn/en/getting-started/vercel.md): One-click deploy of the web app in self-hosted mode — no environment variables required.

### Architecture

- [Architecture overview](https://docs.magic-resume.cn/en/architecture/index.md): A high-level map of the Magic Resume codebase — workspaces, data flow, and where to look when you touch X.
- [Monorepo layout](https://docs.magic-resume.cn/en/architecture/monorepo.md): Workspaces, package boundaries, and what is allowed to import what.
- [Deployment modes](https://docs.magic-resume.cn/en/architecture/deployment-modes.md): How NEXT_PUBLIC_APP_MODE flips the app between self-hosted and cloud.
- [State management](https://docs.magic-resume.cn/en/architecture/state-management.md): Zustand stores, Immer drafts, IndexedDB persistence, and how cloud sync ties in.
- [HTTP clients](https://docs.magic-resume.cn/en/architecture/http-clients.md): One gateway origin, two Axios instances for call-site semantics, a shared auth interceptor, and centralized routes.
- [Resume schema](https://docs.magic-resume.cn/en/architecture/resume-schema.md): The Zod-typed source of truth for what a resume is.
- [Template system](https://docs.magic-resume.cn/en/architecture/templates.md): The Magic Template DSL, the registry, and how to add a new template.

### MCP server

- [MCP server overview](https://docs.magic-resume.cn/en/mcp/index.md): @magic-resume/mcp is a native Model Context Protocol server that exposes your resumes to AI coding tools as typed, patch-editable resources.
- [Setup](https://docs.magic-resume.cn/en/mcp/setup.md): Configure the MCP server and register it with Claude Code, Cursor, or any MCP client.
- [Tool reference](https://docs.magic-resume.cn/en/mcp/tools.md): Every MCP tool exposed by @magic-resume/mcp, what it does, and when to use it.
- [Internals](https://docs.magic-resume.cn/en/mcp/internals.md): How @magic-resume/mcp is wired internally — entry points, config, and the Core API contract.

### Development

- [Local development](https://docs.magic-resume.cn/en/development/index.md): Day-to-day development workflow for the Magic Resume monorepo.
- [Commands](https://docs.magic-resume.cn/en/development/commands.md): Every pnpm and turbo command worth remembering.
- [Contributing](https://docs.magic-resume.cn/en/development/contributing.md): How to contribute code, docs, or templates to Magic Resume.

> The links below point to documentation indexes. Follow each `/_llms/` index recursively until you reach documentation pages.

## Indexes

- [Chinese (40 pages)](https://docs.magic-resume.cn/_llms/zh.md): Documentation for Chinese.