JuanCanham/HackMyResume
1
0
Fork 0
mirror of https://github.com/JuanCanham/HackMyResume.git synced 2024-11-05 09:56:22 +00:00
Code Issues Releases Wiki Activity

Add shortcut options to man page.

Browse Source
This commit is contained in:
hacksalot 2016-01-11 08:31:05 -05:00
parent 815ee3dc7e
commit 542776fd2e
1 changed files with 33 additions and 33 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

66
src/cli/use.txt
View File

@ -1,50 +1,50 @@
Usage: Usage:
hackmyresume <command> <sources> [TO <targets>] [<options>] hackmyresume <command> <sources> [TO <targets>] [<options>]
Available commands: Available commands:
BUILD Build your resume to the destination format(s). BUILD Build your resume to the destination format(s).
ANALYZE Analyze your resume for keywords, gaps, and metrics. ANALYZE Analyze your resume for keywords, gaps, and metrics.
VALIDATE Validate your resume for errors and typos. VALIDATE Validate your resume for errors and typos.
CONVERT Convert your resume between FRESH and JSON Resume. CONVERT Convert your resume between FRESH and JSON Resume.
NEW Create a new resume in FRESH or JSON Resume format. NEW Create a new resume in FRESH or JSON Resume format.
Available options: Available options:
--theme Path to a FRESH or JSON Resume theme. --theme -t Path to a FRESH or JSON Resume theme.
--pdf Specify the PDF engine to use (if any). --pdf -p Specify the PDF engine to use (if any).
--opts Load options from an external JSON file. --opts -o Load options from an external JSON file.
--format The format (FRESH or JSON Resume) to use. --format -f The format (FRESH or JSON Resume) to use.
--debug Emit extended debugging info. --debug -d Emit extended debugging info.
--assert Treat resume validation warnings as errors. --assert -a Treat resume validation warnings as errors.
--no-colors Disable terminal colors. --no-colors Disable terminal colors.
--no-tips Disable theme messages and tips. --no-tips Disable theme messages and tips.
--help Display help documentation. --help -h Display help documentation.
--version Display the current version. --version -v Display the current version.
Not all options are supported for all commands. For example, the Not all options are supported for all commands. For example, the
--theme option is only supported for the BUILD command. --theme option is only supported for the BUILD command.
Examples: Examples:
hackmyresume BUILD resume.json TO out/resume.all --theme modern hackmyresume BUILD resume.json TO out/resume.all --theme modern
hackmyresume ANALYZE resume.json hackmyresume ANALYZE resume.json
hackmyresume NEW my-new-resume.json --format JRS hackmyresume NEW my-new-resume.json --format JRS
hackmyresume CONVERT resume-fresh.json TO resume-jrs.json hackmyresume CONVERT resume-fresh.json TO resume-jrs.json
hackmyresume VALIDATE resume.json hackmyresume VALIDATE resume.json
Tips: Tips:
- You can specify multiple sources and/or targets for all commands. - You can specify multiple sources and/or targets for all commands.
- You can use any FRESH or JSON Resume theme with HackMyResume. - You can use any FRESH or JSON Resume theme with HackMyResume.
- Specify a file extension of .all to generate your resume to all - Specify a file extension of .all to generate your resume to all
available formats supported by the theme. (BUILD command.) available formats supported by the theme. (BUILD command.)
- The --theme parameter can specify either the name of a preinstalled - The --theme parameter can specify either the name of a preinstalled
theme, or the path to a local FRESH or JSON Resume theme. theme, or the path to a local FRESH or JSON Resume theme.
- Visit https://www.npmjs.com/search?q=jsonresume-theme for a full - Visit https://www.npmjs.com/search?q=jsonresume-theme for a full
listing of all available JSON Resume themes. listing of all available JSON Resume themes.
- Visit https://github.com/fluentdesk/fresh-themes for a complete - Visit https://github.com/fluentdesk/fresh-themes for a complete
listing of all available FRESH themes. listing of all available FRESH themes.
- Report bugs to https://githut.com/hacksalot/HackMyResume/issues - Report bugs to https://githut.com/hacksalot/HackMyResume/issues
for a quick fix, often within 24 hours. for a quick fix, often within 24 hours.