rendercv/docs/user_guide/index.md

Get Started

Installation

1. Install Python (3.12 or newer).

2. Run the command below to install RenderCV.

   === "pip"

    ```
    pip install "rendercv[full]"
    ```
   

   === "pipx"

    ```
    pipx install "rendercv[full]"
    ```
   

   === "uv"

    ```
    uv tool install "rendercv[full]"
    ```
   

   === "Docker"

    Docker image is available at [ghcr.io/rendercv/rendercv](https://github.com/rendercv/rendercv/pkgs/container/rendercv).
   
    ```bash
    docker run -v "$PWD":/work -w /work ghcr.io/rendercv/rendercv new "Your Name"
    ```
   

Quick Start

1. Create a new CV YAML input file

   rendercv new "Your Name"
   

   This creates a YAML input file called Your_Name_CV.yaml. This file contains the content, design options, translations and settings for RenderCV. See YAML Input Structure for the full reference.

   See the CLI Reference for the complete list of options available for the new command.

   !!! tip To get started with another language or theme, you can use the --locale and --theme options:

    ```bash
    rendercv new "Your Name" --locale "turkish" --theme "engineeringresumes"
    ```
   

2. Render the YAML input file with

   rendercv render "Your_Name_CV.yaml"
   

   This generates a rendercv_output/ directory containing:

   • John_Doe_CV.pdf: Your CV as PDF
   • John_Doe_CV.typ: Typst source code of the PDF
   • John_Doe_CV_1.png, ..._2.png, ...: PNG images of each page of the PDF
   • John_Doe_CV.md: Your CV as Markdown
   • John_Doe_CV.html: Your CV as HTML (generated from the Markdown)

   See the CLI Reference for the complete list of options available for the render command.

   !!! tip To re-render automatically whenever you save changes, use the --watch option:

    ```bash
    rendercv render --watch "Your_Name_CV.yaml"
    ```