CLI
YAMLResume は履歴書の管理を支援する CLI ツールを提供します。インストールガイド に従ってインストールできます。
Docker での YAMLResume CLI
docker イメージ をご用意しており、yamlresume CLI およびすべての必要な依存関係がインストールされていることに注意してください。
このガイドの各サブコマンドについて、yamlresume/yamlresume の後にサブコマンドを追加することで docker で実行できます。
例えば、yamlresume CLI で新しい履歴書を作成：
yamlresume new my-resume.ymldocker でも実行できます：
docker run --rm -v $(pwd):/home/yamlresume yamlresume/yamlresume new my-resume.ymlヘルプ
CLI ヘルプとすべての利用可能なコマンドを表示：
$ yamlresume help
Usage: yamlresume [options] [command]
YAMLResume — Resume as Code in YAML
__ __ _ __ __ _ ____
\ \ / // \ | \/ | | | _ \ ___ ___ _ _ ___ ___ ___
\ V // _ \ | |\/| | | | |_) / _ \/ __| | | / _ \/ _ \ / _ \
| |/ ___ \| | | | |___| _ < __/\__ \ |_| | | | | | | __/
|_/_/ \_\_| |_|_____|_| \_\___||___/\____|_| |_| |_|\___|
Options:
-V, --version output the version number
-v, --verbose verbose output
-h, --help display help for command
Commands:
new [filename] create a new resume
build [options] <resume-path> build a resume to LaTeX and PDF
dev [options] <resume-path> build a resume on file changes (watch mode)
languages i18n and l10n support
templates manage resume templates
validate <resume-path> validate a resume against the YAMLResume schema
help [command] display help for commandYAMLResume CLI のバージョンを表示：
$ yamlresume -V
0.5.0New
新しい履歴書を作成。デフォルトの履歴書ファイル名は resume.yml ですが、カスタムファイル名を指定できます：
$ yamlresume new --help
Usage: yamlresume new [options] [filename]
create a new resume
Arguments:
filename output filename (default: "resume.yml")
Options:
-h, --help display help for command
$ yamlresume new my-resume.yml
✔ Created my-resume.yml successfully.Build
YAML から PDF に履歴書をビルド。latex コードと PDF の両方を生成し、XeTeX をタイプセッティングエンジンとして使用する場合、.aux、.log などのいくつかの中間ファイルも生成されます。
$ yamlresume build --help
Usage: yamlresume build [options] <resume-path>
build a resume to LaTeX and PDF
Arguments:
resume-path the resume file path
Options:
--no-pdf only generate TeX file without PDF
--no-validate skip resume schema validation
-h, --help display help for command
$ yamlresume build my-resume.yml
◐ Generating resume PDF file with command: xelatex -halt-on-error my-resume.tex...
✔ Generated resume PDF file successfully.--no-pdf
LaTeX ファイルのみを生成し、PDF を生成したくない場合は、--no-pdf オプションを使用できます。
$ yamlresume build --no-pdf my-resume.yml--no-validate
履歴書スキーマ検証をスキップしたい場合は、--no-validate オプションを使用できます。
$ yamlresume build --no-validate my-resume.ymlDev
ファイル変更時に YAML から PDF に履歴書をビルド。build と同じオプションを受け入れますが、YAML ファイルが変更されると自動的に履歴書を再ビルドします（つまり、ウォッチモード）。履歴書の変更をリアルタイムでプレビューするのに非常に便利です。
$ yamlresume dev --help
Usage: yamlresume dev [options] <resume-path>
build a resume on file changes (watch mode)
Arguments:
resume-path the resume file path
Options:
--no-pdf only generate TeX file without PDF
--no-validate skip resume schema validation
-h, --help display help for commandValidate
YAMLResume スキーマ に従って履歴書を検証。
$ yamlresume validate --help
Usage: yamlresume validate [options] <resume-path>
validate a resume against the YAMLResume schema
Arguments:
resume-path the resume file path
Options:
-h, --help display help for command例えば、以下の履歴書について：
# yaml-language-server: $schema=https://yamlresume.dev/schema.json
---
content:
basics:
name: Andy Dufresne
headline: Headed for the Pacific
phone: "(213) 555-9876"
email: hi@pp
url: https//ppresume.com/gallery
summary: |
- Computer Science major with strong foundation in data structures, algorithms, and software development
- Pixel perfect full stack web developer, specialised in creating high-quality, visually appealing websites
- Experiened in databases (SQL, NoSQL), familiar with server-side technologies (Node.js, Express, etc.)
- Team player, with detail-oriented mindset and a keen eye for design and user experiences
location:
address: 123 Main Street
region: California
city: S
country: United States
postalCode: "95814"
education:
- institution: University of Southern California
url: https://www.cs.usc.edu/
degree: Bachelor
area: Computer Engineering and Computer Science
score: "3.8"
startDate: Sep 1, 2016
endDate:
courses:
- D
- Programming Language Concepts
summary: |
- Developed proficiency in programming languages such as Java, C++, and Python
- Gained hands-on experience in software development through various projects and assignments
- Strong communication and teamwork skills acquired through group projects and presentations
layout:
typography:
fontSize: 13ptyamlresume validate は潜在的なエラーのリストを提供し、明確な位置情報を提供します
$ yamlresume validate my-resume.yml
invalid-resume.yml:9:12: warning: email is invalid.
email: hi@pp
^
invalid-resume.yml:19:11: warning: city should be 2 characters or more.
city: S
^
invalid-resume.yml:31:11: warning: courses should be 2 characters or more.
- D
^
invalid-resume.yml:40:15: warning: font size option is invalid, it must be one of the following: ["10pt", "11pt", "12pt"]
fontSize: 13pt
^
✖ Resume validation failed.Languages
すべての利用可能な言語をリスト。言語コードは ISO 639 仕様 の仕様に従います。layout.locale.language で言語コードを指定して履歴書の言語を変更できます。履歴書の言語を変更すると、すべての固定用語が自動的に翻訳されます。詳細については コンテンツ -> 多言語 セクションをご覧ください。
$ yamlresume languages list
| `layout.locale.language` | Language Name |
| ------------------------ | ------------------------------- |
| en | English |
| zh-hans | Simplified Chinese |
| zh-hant-hk | Traditional Chinese (Hong Kong) |
| zh-hant-tw | Traditional Chinese (Taiwan) |
| es | Spanish |Templates
すべての利用可能なテンプレートをリスト。YAML 履歴書で layout.template を設定することで履歴書テンプレートを変更できます。詳細については PPResume テンプレート をご覧ください。
$ yamlresume templates list
| `layout.template` | Template Name | Description |
| ----------------- | ---------------- | ------------------------------------ |
| moderncv-banking | ModernCV Banking | ModernCV template with banking style |
| moderncv-casual | ModernCV Casual | ModernCV template with casual style |
| moderncv-classic | ModernCV Classic | ModernCV template with classic style |Edit on GitHub
Last updated on