HackMyResume ============ [![Build status][travis-image]][travis-url] *Create polished résumés and CVs in multiple formats from your command line or shell. Author in clean Markdown and JSON, export to Word, HTML, PDF, LaTeX, plain text, and other arbitrary formats. Fight the power, save trees. Compatible with [FRESH][fresca] and [JRS][6] resumes.* ![](assets/resume-bouqet.png) HackMyResume is a dev-friendly, local-only Swiss Army knife for resumes and CVs. Use it to: 1. **Generate** HTML, Markdown, LaTeX, MS Word, PDF, plain text, JSON, XML, YAML, print, smoke signal, carrier pigeon, and other arbitrary-format resumes and CVs, from a single source of truth—without violating DRY. 2. **Convert** resumes between [FRESH][fresca] and [JSON Resume][6] formats. 3. **Validate** resumes against either format. HackMyResume is built with Node.js and runs on recent versions of OS X, Linux, or Windows. ## Features - OS X, Linux, and Windows. - Store your resume data as a durable, versionable JSON or YAML document. - Generate polished resumes in multiple formats without violating [DRY][dry]. - Output to HTML, Markdown, LaTeX, PDF, MS Word, JSON, YAML, plain text, or XML. - Validate resumes against the FRESH or JSON Resume schema. - Support for multiple input and output resumes. - Use from your command line or [desktop][7]. - Free and open-source through the MIT license. ## Install Install HackMyResume with NPM: ```bash [sudo] npm install hackmyresume -g ``` Note: for PDF generation you'll need to install a copy of [wkhtmltopdf][3] for your platform. For LaTeX generation you'll need a valid LaTeX environment with access to `xelatex` and similar. ## Getting Started To use HackMyResume you'll need to create a valid resume in either [FRESH][fresca] or [JSON Resume][6] format. Then you can start using the command line tool. There are four basic commands you should be aware of: - **build** generates resumes in HTML, Word, Markdown, PDF, and other formats. Use it when you need to submit, upload, print, or email resumes in specific formats. ```bash # hackmyresume BUILD TO [-t THEME] hackmyresume BUILD resume.json TO out/resume.all hackmyresume BUILD r1.json r2.json TO out/rez.html out/rez.md foo/rez.all ``` - **new** creates a new resume in FRESH or JSON Resume format. ```bash # hackmyresume NEW [-f ] hackmyresume NEW resume.json hackmyresume NEW resume.json -f fresh hackmyresume NEW r1.json r2.json -f jrs ``` - **convert** converts your source resume between FRESH and JSON Resume formats. Use it to convert between the two formats to take advantage of tools and services. ```bash # hackmyresume CONVERT TO hackmyresume CONVERT resume.json TO resume-jrs.json hackmyresume CONVERT 1.json 2.json 3.json TO out/1.json out/2.json out/3.json ``` - **validate** validates the specified resume against either the FRESH or JSON Resume schema. Use it to make sure your resume data is sufficient and complete. ```bash # hackmyresume VALIDATE hackmyresume VALIDATE resume.json hackmyresume VALIDATE r1.json r2.json r3.json ``` ## Supported Output Formats HackMyResume supports these output formats: Output Format | Ext | Notes ------------- | --- | ----- HTML | .html | A standard HTML 5 + CSS resume format that can be viewed in a browser, deployed to a website, etc. Markdown | .md | A structured Markdown document that can be used as-is or used to generate HTML. LaTeX | .tex | A structured LaTeX document (or collection of documents). MS Word | .doc | A Microsoft Word office document. Adobe Acrobat (PDF) | .pdf | A binary PDF document driven by an HTML theme. plain text | .txt | A formatted plain text document appropriate for emails or copy-paste. JSON | .json | A JSON representation of the resume. YAML | .yml | A YAML representation of the resume. RTF | .rtf | Forthcoming. Textile | .textile | Forthcoming. image | .png, .bmp | Forthcoming. ## Install HackMyResume requires a recent version of [Node.js][4] and [NPM][5]. Then: 1. Install the latest official [wkhtmltopdf][3] binary for your platform. 2. Optionally install an updated LaTeX environment (LaTeX resumes only). 2. Install **HackMyResume** with `[sudo] npm install hackmyresume -g`. 3. You're ready to go. ## Use Assuming you've got a JSON-formatted resume handy, generating resumes in different formats and combinations easy. Just run: ```bash hackmyresume BUILD [-t theme]. ``` Where `` is one or more .json resume files, separated by spaces; `` is one or more destination resumes, and `` is the desired theme (default to Modern). For example: ```bash # Generate all resume formats (HTML, PDF, DOC, TXT, YML, etc.) hackmyresume build resume.json -o out/resume.all -t modern # Generate a specific resume format hackmyresume build resume.json TO out/resume.html hackmyresume build resume.json TO out/resume.pdf hackmyresume build resume.json TO out/resume.md hackmyresume build resume.json TO out/resume.doc hackmyresume build resume.json TO out/resume.json hackmyresume build resume.json TO out/resume.txt hackmyresume build resume.json TO out/resume.yml # Specify 2 inputs and 3 outputs hackmyresume build in1.json in2.json TO out.html out.doc out.pdf ``` You should see something to the effect of: ``` *** HackMyResume v0.9.0 *** Reading JSON resume: foo/resume.json Applying MODERN Theme (7 formats) Generating HTML resume: out/resume.html Generating TXT resume: out/resume.txt Generating DOC resume: out/resume.doc Generating PDF resume: out/resume.pdf Generating JSON resume: out/resume.json Generating MARKDOWN resume: out/resume.md Generating YAML resume: out/resume.yml ``` ## Advanced ### Applying a theme You can specify a predefined or custom theme via the optional `-t` parameter. For a predefined theme, include the theme name. For a custom theme, include the path to the custom theme's folder. ```bash hackmyresume build resume.json -t modern hackmyresume build resume.json -t ~/foo/bar/my-custom-theme/ ``` As of v1.0.0, available predefined themes are `positive`, `modern`, `compact`, `minimist`, and `hello-world`. ### Merging resumes You can **merge multiple resumes together** by specifying them in order from most generic to most specific: ```bash # Merge specific.json onto base.json and generate all formats hackmyresume build base.json specific.json -o resume.all ``` This can be useful for overriding a base (generic) resume with information from a specific (targeted) resume. For example, you might override your generic catch-all "software developer" resume with specific details from your targeted "game developer" resume, or combine two partial resumes into a "complete" resume. Merging follows conventional [extend()][9]-style behavior and there's no arbitrary limit to how many resumes you can merge: ```bash hackmyresume build in1.json in2.json in3.json in4.json TO out.html out.doc Reading JSON resume: in1.json Reading JSON resume: in2.json Reading JSON resume: in3.json Reading JSON resume: in4.json Merging in4.json onto in3.json onto in2.json onto in1.json Generating HTML resume: out.html Generating WORD resume: out.doc ``` ### Multiple targets You can specify **multiple output targets** and HackMyResume will build them: ```bash # Generate out1.doc, out1.pdf, and foo.txt from me.json. hackmyresume build me.json -o out1.doc -o out1.pdf -o foo.txt ``` You can also omit the output file(s) and/or theme completely: ```bash # Equivalent to "hackmyresume resume.json resume.all -t modern" hackmyresume build resume.json ``` ### Using .all The special `.all` extension tells HackMyResume to generate all supported output formats for the given resume. For example, this... ```bash # Generate all resume formats (HTML, PDF, DOC, TXT, etc.) hackmyresume build me.json -o out/resume.all ``` ..tells HackMyResume to read `me.json` and generate `out/resume.md`, `out/resume.doc`, `out/resume.html`, `out/resume.txt`, `out/resume.pdf`, and `out/resume.json`. ### Validating HackMyResume can also validate your resumes against either the [FRESH / FRESCA][fresca] or [JSON Resume][6] formats. To validate one or more existing resumes, use the `validate` command: ```bash # Validate myresume.json against either the FRESH or JSON Resume schema. hackmyresume validate resumeA.json resumeB.json ``` HackMyResume will validate each specified resume in turn: ```bash *** HackMyResume v0.9.0 *** Validating JSON resume: resumeA.json (INVALID) Validating JSON resume: resumeB.json (VALID) ``` ### Converting HackMyResume can convert between the [FRESH][fresca] and [JSON Resume][6] formats. Just run: ```bash hackmyresume CONVERT ``` where is one or more resumes in FRESH or JSON Resume format, and is a corresponding list of output file names. HackMyResume will autodetect the format (FRESH or JRS) of each input resume and convert it to the other format (JRS or FRESH). ### Prettifying HackMyResume applies [js-beautify][10]-style HTML prettification by default to HTML-formatted resumes. To disable prettification, the `--nopretty` or `-n` flag can be used: ```bash hackmyresume generate resume.json out.all --nopretty ``` ### Silent Mode Use `-s` or `--silent` to run in silent mode: ```bash hackmyresume generate resume.json -o someFile.all -s hackmyresume generate resume.json -o someFile.all --silent ``` ## License MIT. Go crazy. See [LICENSE.md][1] for details. [1]: LICENSE.md [2]: http://phantomjs.org/ [3]: http://wkhtmltopdf.org/ [4]: https://nodejs.org/ [5]: https://www.npmjs.com/ [6]: http://jsonresume.org [7]: http://fluentcv.com [8]: https://youtu.be/N9wsjroVlu8 [9]: https://api.jquery.com/jquery.extend/ [10]: https://github.com/beautify-web/js-beautify [fresh]: https://github.com/fluentdesk/FRESH [fresca]: https://github.com/fluentdesk/FRESCA [dry]: https://en.wikipedia.org/wiki/Don%27t_repeat_yourself [travis-url]: https://travis-ci.org/hacksalot/HackMyResume