incipit は何をしますか?
ここから新しいキャリアが始まります。テンプレート駆動のCLIツールで、構造化された履歴書データを洗練されたPDF、DOCX、HTML、LaTeX、Markdownに変換します。プラグ可能なテンプレートとマルチエージェントAI評価機能を備えています。
概要
urmzd/incipit は、構造化された履歴書データ(JSONまたはYAML形式)を入力として受け取り、複数の出力形式に変換するコマンドラインツールです。テンプレートエンジンにより、ユーザーは独自のテンプレートをプラグインとして追加でき、出力の柔軟性が向上します。また、マルチエージェントAI評価機能を内蔵しており、生成された履歴書に対してAIエージェントがフィードバックや改善提案を行います。
主な機能
- 複数出力形式: PDF、DOCX、HTML、LaTeX、Markdownに対応
- プラグ可能なテンプレート: カスタムテンプレートを簡単に追加可能
- マルチエージェントAI評価: 複数のAIエージェントが履歴書を評価し、改善点を提案
- 簡単なCLI操作: 直感的なコマンドラインインターフェース
インストール
npm install -g urmzd/incipit
または、リポジトリをクローンして直接使用します。
git clone https://github.com/urmzd/incipit.git
cd incipit
npm install
npm link
使用方法
基本的な使用方法
incipit build -i resume.json -o output.pdf
利用可能なオプション
| オプション | 説明 |
|---|---|
-i, --input | 入力ファイル(JSONまたはYAML) |
-o, --output | 出力ファイル名 |
-t, --template | 使用するテンプレート(デフォルト: default) |
-f, --format | 出力形式(pdf, docx, html, latex, markdown) |
--ai-assess | AI評価を実行 |
例
-
基本的なPDF生成:
incipit build -i resume.yaml -o resume.pdf -
カスタムテンプレートでHTML生成:
incipit build -i resume.json -o resume.html -t modern -f html -
AI評価を有効にして生成:
incipit build -i resume.yaml -o resume.pdf --ai-assess
テンプレート
テンプレートは templates/ ディレクトリに配置します。各テンプレートは、出力形式ごとにフォルダ分けされています。
templates/
├── default/
│ ├── pdf/
│ ├── html/
│ └── markdown/
└── modern/
├── pdf/
└── html/
カスタムテンプレートの作成
templates/<テンプレート名>/<形式>/ディレクトリを作成- テンプレートファイル(例:
main.hbsHandlebarsテンプレート)を配置 incipit build -t <テンプレート名>で使用
データ形式
入力データは以下のような構造のJSONまたはYAML形式である必要があります。
{
"personal": {
"name": "山田 太郎",
"email": "[email protected]",
"phone": "090-1234-5678"
},
"experience": [
{
"company": "株式会社テック",
"position": "ソフトウェアエンジニア",
"startDate": "2020-04",
"endDate": "2023-03",
"description": "フルスタック開発に従事"
}
],
"education": [
{
"institution": "東京大学",
"degree": "学士",
"field": "情報工学"
}
]
}
AI評価機能
--ai-assess フラグを有効にすると、複数のAIエージェントが履歴書を評価し、以下のようなフィードバックを提供します。
- フォーマットの改善点
- スキルの表現強化
- 職務経歴の明確化
- 全体的な印象
開発者向け情報
プロジェクト構成
incipit/
├── src/
│ ├── commands/
│ ├── templates/
│ ├── formats/
│ └── ai/
├── templates/
├── test/
├── package.json
└── README.md
貢献方法
- このリポジトリをフォーク
- 機能ブランチを作成 (
git checkout -b feature/新機能) - 変更をコミット (
git commit -am '新機能を追加') - ブランチにプッシュ (
git push origin feature/新機能) - プルリクエストを作成
ライセンス
MITライセンスの下で公開されています。詳細は LICENSE ファイルを参照してください。
作者
- urmzd (https://github.com/urmzd)