1
0
mirror of https://github.com/JuanCanham/HackMyResume.git synced 2025-08-13 12:01:06 +01:00

feat: introduce HELP command

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
This commit is contained in:
hacksalot
2018-02-10 13:03:52 -05:00
parent 2281b4ea7f
commit 98f20c368c
18 changed files with 546 additions and 59 deletions

34
src/cli/help/convert.txt Normal file
View File

@@ -0,0 +1,34 @@
**convert** | Convert resumes between FRESH and JRS formats
Usage:
hackmyresume CONVERT <sources...> TO <targets...> [<options>]
Parameters:
**<sources...>**
Absolute or relative path(s) to one or more FRESH or
JSON Resume documents (*.json), separated by spaces.
**<targets...>**
The desired absolute or relative path(s) of the newly
converted resume(s). HackMyResume will create the
converted resume(s) here.
Options:
**--format -f <fmt>**
The desired format for the new resume(s). Valid values
are 'FRESH', 'JRS', or, to target the latest edge
version of the JSON Resume Schema, 'JRS@1'.
If this parameter is omitted, the destination format
will be inferred from the source resume's format. If
the source format is FRESH, the destination format
will be JSON Resume, and vice-versa.
The CONVERT command converts one or more resume documents
between FRESH and JSON Resume formats.