A CLI tool that turns your local projects into a personal portfolio website. It scans your git repositories, uses your local AI tools (Claude Code, Codex, or v0) to generate a production-ready Next.js site, and deploys it to Cloudflare Pages or Vercel -- all in one command.
Built for developers who ship fast and need a way to showcase their work without spending hours on a portfolio.
npx shipfolio --scan ~/Projects
The tool walks you through everything interactively: project selection, personal info, design preferences, and deployment.
| Engine | How to get it | Notes |
|---|---|---|
| Claude Code | npm install -g @anthropic-ai/claude-code | Recommended. Best overall generation quality. |
| Codex | npm install -g @openai/codex | Alternative. |
| v0 | Set V0_API_KEY environment variable | Best UI design quality. Requires paid v0 plan. Get your key at v0.dev. |
No need to install wrangler or vercel CLI -- shipfolio calls them via npx automatically.
npx shipfolio --scan ~/Projects
npx shipfolio --scan ~/Projects --output ./my-site
npx shipfolio --scan ~/Projects --no-pdf --no-preview
The pipeline:
npx shipfolio update --site ./shipfolio-site
npx shipfolio update --site ./shipfolio-site --scan ~/Projects
Detects new/changed/removed projects and applies incremental updates. Preserves existing design, layout, and custom modifications.
For use inside an existing Claude Code or Codex session:
npx shipfolio spec --scan ~/Projects --output ./
Outputs shipfolio-spec.json and shipfolio-prompt.md. Feed the prompt to your AI session to generate the site directly.
npx shipfolio deploy --site ./shipfolio-site --platform cloudflare
npx shipfolio deploy --site ./shipfolio-site --platform vercel
npx shipfolio pdf --site ./shipfolio-site
Requires Playwright: npx playwright install chromium
npx shipfolio preview --site ./shipfolio-site --port 3000
shipfolio init (default)| Flag | Description | Default |
|---|---|---|
-s, --scan <dirs...> | Directories to scan for projects | Current directory |
-o, --output <dir> | Output directory | ./shipfolio-site |
--no-pdf | Skip PDF export | |
--no-preview | Skip local preview |
shipfolio update| Flag | Description |
|---|---|
--site <path> | Path to existing site directory (required) |
-s, --scan <dirs...> | Directories to scan |
--no-pdf | Skip PDF export |
--no-preview | Skip preview |
--no-deploy | Skip deployment |
shipfolio deploy| Flag | Description |
|---|---|
--site <path> | Path to site directory (required) |
-p, --platform <name> | cloudflare or vercel |
shipfolio spec| Flag | Description |
|---|---|
-s, --scan <dirs...> | Directories to scan |
-o, --output <dir> | Output directory for spec files |
shipfolio pdf| Flag | Description |
|---|---|
--site <path> | Path to site directory (required) |
-o, --output <path> | PDF output path |
shipfolio preview| Flag | Description |
|---|---|
--site <path> | Path to site directory (required) |
--port <port> | Port number (default: 3000, auto-fallback if in use) |
When you have related projects (e.g. a web app and its mobile companion), shipfolio lets you merge them into a single portfolio entry. Tech stacks, commit histories, and READMEs are combined automatically.
If the process crashes or you cancel after the interview step, your answers are saved to ~/.shipfolio/draft.json. Next time you run shipfolio, it offers to restore them.
The CLI detects your system locale. Chinese (zh-CN, zh-TW) users see Chinese prompts; everyone else sees English.
During the deploy step, you can specify a custom domain. For Vercel, it is configured automatically via vercel domains add. For Cloudflare Pages, shipfolio prints a direct link to the dashboard with instructions.
After deployment, shipfolio can create a GitHub repo and add a .github/workflows/deploy.yml that redeploys on every push. You just need to add one or two secrets to the repo:
Cloudflare Pages:
gh secret set CLOUDFLARE_API_TOKEN
gh secret set CLOUDFLARE_ACCOUNT_ID
Vercel:
gh secret set VERCEL_TOKEN
output: 'export')out/ directoryNo CLI pre-install needed. On first run, npx wrangler login opens a browser for authentication. The project is auto-created. Your site gets a <project-name>.pages.dev URL.
Free tier: unlimited sites, 500 builds/month, unlimited bandwidth.
No CLI pre-install needed. On first run, npx vercel login opens a browser for authentication. Your site gets a <project-name>.vercel.app URL.
MIT
一个 CLI 工具，将你本地的项目转化为个人作品集网站。它扫描你的 git 仓库，使用你本地的 AI 工具（Claude Code、Codex 或 v0）生成生产级 Next.js 网站，并一键部署到 Cloudflare Pages 或 Vercel。
为快速交付项目但没时间做作品集的开发者而建。
npx shipfolio --scan ~/Projects
工具会以交互方式引导你完成所有步骤：项目选择、个人信息、设计偏好、部署。
| 引擎 | 安装方式 | 说明 |
|---|---|---|
| Claude Code | npm install -g @anthropic-ai/claude-code | 推荐。综合生成质量最佳。 |
| Codex | npm install -g @openai/codex | 备选。 |
| v0 | 设置 V0_API_KEY 环境变量 | UI 设计质量最佳。需要 v0 付费订阅。在 v0.dev 获取 API key。 |
不需要预装 wrangler 或 vercel CLI -- shipfolio 通过 npx 自动调用。
npx shipfolio --scan ~/Projects
npx shipfolio --scan ~/Projects --output ./my-site
npx shipfolio --scan ~/Projects --no-pdf --no-preview
流程:
npx shipfolio update --site ./shipfolio-site
npx shipfolio update --site ./shipfolio-site --scan ~/Projects
检测新增/变更/移除的项目，增量更新。保留现有设计、布局和自定义修改。
在 Claude Code 或 Codex 会话中使用:
npx shipfolio spec --scan ~/Projects --output ./
输出 shipfolio-spec.json 和 shipfolio-prompt.md。将 prompt 输入 AI 会话即可直接生成网站。
npx shipfolio deploy --site ./shipfolio-site --platform cloudflare
npx shipfolio deploy --site ./shipfolio-site --platform vercel
npx shipfolio pdf --site ./shipfolio-site
需要 Playwright: npx playwright install chromium
npx shipfolio preview --site ./shipfolio-site --port 3000
shipfolio init（默认命令）| 参数 | 说明 | 默认值 |
|---|---|---|
-s, --scan <dirs...> | 扫描目录 | 当前目录 |
-o, --output <dir> | 输出目录 | ./shipfolio-site |
--no-pdf | 跳过 PDF 导出 | |
--no-preview | 跳过本地预览 |
shipfolio update| 参数 | 说明 |
|---|---|
--site <path> | 已有网站目录（必填） |
-s, --scan <dirs...> | 扫描目录 |
--no-pdf | 跳过 PDF 导出 |
--no-preview | 跳过预览 |
--no-deploy | 跳过部署 |
shipfolio deploy| 参数 | 说明 |
|---|---|
--site <path> | 网站目录（必填） |
-p, --platform <name> | cloudflare 或 vercel |
shipfolio spec| 参数 | 说明 |
|---|---|
-s, --scan <dirs...> | 扫描目录 |
-o, --output <dir> | Spec 文件输出目录 |
shipfolio pdf| 参数 | 说明 |
|---|---|
--site <path> | 网站目录（必填） |
-o, --output <path> | PDF 输出路径 |
shipfolio preview| 参数 | 说明 |
|---|---|
--site <path> | 网站目录（必填） |
--port <port> | 端口号（默认 3000，占用时自动切换） |
当你有关联项目时（如 web 端和 mobile 端），shipfolio 支持将它们合并为一个作品集条目。技术栈、提交历史和 README 会自动合并。
如果流程中断或在问答环节后崩溃，你的回答会保存到 ~/.shipfolio/draft.json。下次运行时会询问是否恢复。
CLI 自动检测系统语言。简体中文和繁体中文用户看到中文提示，其他语言看到英文。
部署时可指定自定义域名。Vercel 通过 vercel domains add 自动配置。Cloudflare Pages 会打印 dashboard 直链和操作指引。
部署后，shipfolio 可创建 GitHub 仓库并添加 .github/workflows/deploy.yml，每次 push 自动重新部署。只需在仓库中添加 secrets:
Cloudflare Pages:
gh secret set CLOUDFLARE_API_TOKEN
gh secret set CLOUDFLARE_ACCOUNT_ID
Vercel:
gh secret set VERCEL_TOKEN
output: 'export')out/ 目录不需要预装 CLI。首次运行时 npx wrangler login 会打开浏览器进行认证。项目自动创建。网站获得 <项目名>.pages.dev 域名。
免费额度: 无限站点，500 次构建/月，无限带宽。
不需要预装 CLI。首次运行时 npx vercel login 会打开浏览器进行认证。网站获得 <项目名>.vercel.app 域名。
MIT
FAQs
Generate and deploy your personal portfolio site from local projects using AI
The npm package shipfolio receives a total of 0 weekly downloads. As such, shipfolio popularity was classified as not popular.
We found that shipfolio demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Threat Research
/Security News
Socket uncovered secret-stealing workflows that ran in LiteLLM’s GitHub repository 11 days before the supply chain attack on PyPI and Docker.
Security News
Cloudflare introduces tsrs, a Rust port of TypeScript’s compiler promising faster checks and lower memory use, with the TypeScript team’s help.
Security News
The PHP Foundation says Chainguard broke a security embargo ahead of critical RCE patches, as leaks disrupted the coordinated release.