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

Update man page.

Browse Source
This commit is contained in:
hacksalot 2016-01-10 18:48:57 -05:00
parent 656dbe2fc2
commit c8cc673ad5
1 changed files with 38 additions and 52 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

90
src/cli/use.txt
View File

@ -1,64 +1,50 @@
Usage: Usage:
hackmyresume <COMMAND> <SOURCES> [TO <TARGETS>] [-t <THEME>] [-f <FORMAT>] hackmyresume <command> <sources> [TO <targets>] [<options>]
<COMMAND> should be BUILD, ANALYZE, NEW, CONVERT, or VALIDATE. <SOURCES> should Available commands:
be the path to one or more FRESH or JSON Resume format resumes. <TARGETS> should
be the name of the destination resume to be created, if any. The <THEME>
parameter should be the name of a predefined theme (for example: COMPACT,
MINIMIST, MODERN, or HELLO-WORLD) or the relative path to a custom theme.
<FORMAT> should be either FRESH (for a FRESH-format resume) or JRS (for a JSON
Resume-format resume).
hackmyresume BUILD resume.json TO out/resume.all BUILD Build your resume to the destination format(s).
hackmyresume ANALYZE resume.json ANALYZE Analyze your resume for keywords, gaps, and metrics.
hackmyresume NEW resume.json VALIDATE Validate your resume for errors and typos.
hackmyresume CONVERT resume.json TO resume-jrs.json CONVERT Convert your resume between FRESH and JSON Resume.
hackmyresume VALIDATE resume.json NEW Create a new resume in FRESH or JSON Resume format.
Both SOURCES and TARGETS can accept multiple files:
hackmyresume BUILD r1.json r2.json TO out/resume.all out2/resume.html
hackmyresume ANALYZE r1.json r2.json r3.json
hackmyresume NEW r1.json r2.json r3.json
hackmyresume CONVERT r1.json r2.json TO o1.json o2.json
hackmyresume VALIDATE r1.json r2.json r3.json
Available options: Available options:
--theme <theme> Specify a theme for the BUILD command. Can be the path --theme Path to a FRESH or JSON Resume theme.
-t <theme> to any FRESH or JSON Resume theme, or the name of one --pdf Specify the PDF engine to use (if any).
of HackMyResume's predefined themes. --opts Load options from an external JSON file.
--format The format (FRESH or JSON Resume) to use.
--debug Emit extended debugging info.
--assert Treat resume validation warnings as errors.
--no-colors Disable terminal colors.
--no-tips Disable theme messages and tips.
--help Display help documentation.
--version Display the current version.
Not all options are supported for all commands. For example, the
--theme option is only supported for the BUILD command.
--pdf <engine> Specify a PDF rendering engine. Can be "wkhtmltopdf", Examples:
-p <engine> "phantom", or "none". Requires that the corresponding
engine be installed and path-accessible.
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
--opts <path> Load HackMyResume options via an external file. Tips:
-o <path>
- You can specify multiple sources and/or targets for all commands.
--color Enable/disable terminal colors. - You can use any FRESH or JSON Resume theme with HackMyResume.
--no-color - 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
--tips Enable/disable theme tips and messages. theme, or the path to a local FRESH or JSON Resume theme.
--no-tips - Visit https://www.npmjs.com/search?q=jsonresume-theme for a full
listing of all available JSON Resume themes.
- Visit https://github.com/fluentdesk/fresh-themes for a complete
--debug Emit debug info. listing of all available FRESH themes.
-d - Report bugs to https://githut.com/hacksalot/HackMyResume/issues
for a quick fix, often within 24 hours.
--help Display help documentation.
-h
--version Display the current HackMyResume version.
-v
See https://github.com/hacksalot/hackmyresume/blob/master/README.md for more
information.