1
0
mirror of https://github.com/JuanCanham/HackMyResume.git synced 2025-08-03 23:56:39 +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

27
src/cli/help/validate.txt Normal file
View File

@@ -0,0 +1,27 @@
**validate** - Validate a resume for correctness
Usage:
hackmyresume VALIDATE <resume> [<options>]
hackmyresume VALIDATE <resumes...> [<options>]
Parameters:
**<resume(s)>**
Absolute or relative path(s) to one or more FRESH or
JSON Resume documents to be validated. Multiple resumes
can be specified, separated by spaces:
hackmyresume ANALYZE r1.json r2.json r3.json
Options:
**--assert -a**
Tell HackMyResume to return a non-zero process exit
code if a resume fails to validate.
The VALIDATE command validates a FRESH or JSON Resume
document against its governing schema, verifying that the
resume is correctly structured.