mirror of
https://github.com/JuanCanham/HackMyResume.git
synced 2025-04-19 06:10:28 +01:00
98f20c368c
Add support for a "HELP" verb in the HackMyResume CLI, allowing separate help pages for each HackMyResume command per #205. The following command invocations are recognized. hackmyresume help hackmyresume help build hackmyresume help new hackmyresume help convert hackmyresume help analyze hackmyresume help validate hackmyresume help peek hackmyresume help help
49 lines
2.0 KiB
Plaintext
49 lines
2.0 KiB
Plaintext
**HackMyResume** | A Swiss Army knife for resumes and CVs.
|
|
|
|
Usage:
|
|
|
|
hackmyresume <command> <params> [<options>]
|
|
|
|
Available commands (type "hackmyresume help COMMAND" for details):
|
|
|
|
**BUILD** Build your resume to the destination format(s).
|
|
**ANALYZE** Analyze your resume for keywords, gaps, and metrics.
|
|
**VALIDATE** Validate your resume for errors and typos.
|
|
**NEW** Create a new resume in FRESH or JSON Resume format.
|
|
**CONVERT** Convert your resume between FRESH and JSON Resume.
|
|
**PEEK** View a specific field or element on your resume.
|
|
**HELP** View help on a specific HackMyResume command.
|
|
|
|
Available options:
|
|
|
|
**--options -o** Load options from an external JSON file.
|
|
**--debug -d** Emit extended debugging info.
|
|
**--assert -a** Treat resume validation warnings as errors.
|
|
**--no-colors** Disable terminal colors.
|
|
**--tips** Display theme messages and tips.
|
|
**--help -h** Display help documentation.
|
|
**--version -v** Display the current version.
|
|
|
|
Examples:
|
|
|
|
hackmyresume BUILD resume.json TO out/resume.all --theme modern
|
|
hackmyresume ANALYZE resume.json
|
|
hackmyresume NEW my-new-resume.json --format JRS
|
|
hackmyresume CONVERT resume-fresh.json TO resume-jrs.json
|
|
hackmyresume VALIDATE resume.json
|
|
hackmyresume PEEK resume.json employment[2].summary
|
|
|
|
Tips:
|
|
|
|
- You can specify multiple sources and/or targets for all commands.
|
|
- You can use any FRESH or JSON Resume theme with HackMyResume.
|
|
- Specify a file extension of .all to generate your resume to all
|
|
available formats supported by the theme. (BUILD command.)
|
|
- The --theme parameter can specify either the name of a preinstalled
|
|
theme, or the path to a local FRESH or JSON Resume theme.
|
|
- Visit https://www.npmjs.com/search?q=jsonresume-theme for a full
|
|
listing of all available JSON Resume themes.
|
|
- Visit https://github.com/fresh-standard/fresh-themes for a complete
|
|
listing of all available FRESH themes.
|
|
- Report bugs to https://githut.com/hacksalot/HackMyResume/issues.
|