resume/cli

Generate a beautiful HTML résumé based on a JSON file.

, _(*1)

Resume CLI

![Software License][ico-license] ![Build Status][ico-circleci] , _(*2)

Generate a beautiful HTML résumé based on a JSON file. You can use [the pre-built templates], download one of the readily available ones, or [write your own] with HTML and CSS., _(*3)

Resume CLI was inspired by (and loosely based on) JSON Resume, and built using Laravel Zero., _(*4)

Index

• Installation
  • Downloading
• Usage
  • Customization
• Contributing
• License

Installation

You'll have to follow a couple of simple steps to install this package., _(*5)

Downloading

Via composer:, _(*6)

$ composer global require resume/cli

Or add the package to your dependencies in composer.json and run composer global update on the command line to download the package:, _(*7)

{
    "require": {
        "resume/cli": "^1.0"
    }
}

Ensure Composer's global bin directory is included in your path. This directory is located at ~/.composer/vendor/bin on macOS / Linux, and at %APPDATA%/Composer/vendor/bin on Windows., _(*8)

Usage

To make a résumé, create a file named resume.json with the following contents:, _(*9)

{
    "name": "John Doe",
    "email": "john@example.com"
}

Running resume make will create a new folder (resume/ by default) with the HTML and CSS required to publish and distribute your CV online., _(*10)

Note: if the folder resume already exists, the command will exit without changing or overwriting anything., _(*11)

Customization

Of course, you may want to customize the way your résumé is generated. You can do so by passing the following options to resume make:, _(*12)

Source file name

To change what file is used for generating your résumé, pass the name of the file to the make command:, _(*13)

$ resume make source.json

Output directory

To specify the name of the output directory for your generated résumé, use the --output option:, _(*14)

$ resume make source.json --output="public"

This will create a public folder and put the generated HTML and CSS in there., _(*15)

Forcefully generating

You may use the --force flag to overwrite any files or folders already in the output directory:, _(*16)

$ resume make --output="public" --force

Theme

You can select a different theme using the --theme option:, _(*17)

# Generate your CV using the "flat" theme.
$ resume make source.json --theme="flat"

More info about adding and writing your own themes can be found here., _(*18)

Previewing your CV

Of course, you'll want to preview your CV before publishing it online. You can do so by using the serve subcommand:, _(*19)

# Serve your CV from the default directory ('resume')
$ resume serve

# Serve your CV from a custom directory ('public', in this case)
$ resume serve public

This will start PHP's built-in webserver on its default port (8000). To change the port it's served on, use the --port option:, _(*20)

# Serve the CV on port 1337 instead of 8000
$ resume serve --port=1337

Contributing

All contributions (pull requests, issues and feature requests) are welcome. Make sure to read through the CONTRIBUTING.md first, though. See the contributors page for all contributors., _(*21)

License

resume/cli is licensed under the MIT License (MIT). Please see the license file for more information., _(*22)