mirror of
https://github.com/rendercv/rendercv.git
synced 2026-01-22 20:28:35 -05:00
5cc5fbdf9e
* Rename `data` folder with schema * Start refactoring data models * Work on entry models * Keep working on entries * Keep working on data models * Push old data files * Keep working on data models * First draft of schema.cv * Keep working on schema * Keep working on schema * Improve schema.models * Keep working on rendercv.schema * Work on schema.design * Keep working on rendercv.schema * Complete variant_class_generator * Keep working rendercv.schema * Keep working on rendercv.schema * Final touches to rendercv.schema * Improve json schema descriptions in rendercv.schema * Start working on rendercv.schema tests * Keep implementing rendercv.schema tests * Add more tests for rendercv.schema * Improve rendercv.schema * Improve docstrings and comments in rendercv.schema * Implement better pydantic error handling in `rendercv.schema` * Improve variant class system * Fix rendercv.schema tests * Start working on rendercv.templater * Update template names * Switching to new rendercv typst template soon * Work on new templater * Rename renderer with renderer_old * Don't use utils in rendercv.schema * Complete connections * Update renderer folder structure * Work on new renderer * Work on new renderer * Date processing on new renderer * Improve date processing, support multiple emails, phones, and websites * Improve markdown to Typst * Complete entry template processing * Time span computation in new renderer * Better entry templates * Setup new templates * Improve rendercv.schema * Start adding tests for rendercv.renderer * New markdown parser! * Improve markdown to typst conversion * Finalize markdown parser * Add new test files for rendercv.renderer * Fix cv and connections * Add connections test * Improve connection tests * Improve entry templates * Add model processor tests * Improve templater * Rename old folders * Improve schema * Add file generation logic to renderer * Fix naming issues * Fix schema tests * Add path type tests * Add font family and typst dimension type tests * Rename old tests * Fix design tests * Start integration testing of renderer * Improve entry tempates * Handle nested highlights properly * Finalize Typst preamble template * Start working on new CLI * Remove old test files * Implement override dictionary in new schema * Start working on new CLI * Better prints on render command * New structure * New render printer * Add all the commands to new CLI * Work on new command in new cli * Improve new command * Add error handler to new cli * Work on create theme command * Complete create theme command * Remove old source files * Improve exceptions * Create new docs * Add writing tests guide * Fix cli printer and write tests * Test copy templates * Add app tests * Bring back accidentally removed files * Imporve cli and tests * Fix path issues * Improve * Improve * Add reference file comparison tests * Fix path resolver * Start working on test_pdf_png * Implement comparison of multiple files (png) * Start testing typst * Fix templating issues * Fix header and entry templates issues * Implement short second rows * Fix date issues * Fix nested bullets and add summary * Update testdata * Implement footer * Update testdata * Reimagined design and locale schema, first iteration * Reimagined design and locale second iteration * Update design and locale schemas * Adapt templater to the new design and locale * Fix tests * Update lib.typ and testdata for the new locale and design * Implement proper tests with all combinations of entries * Remove some docstrings * fix connections logic * Improve * Start working on examples * Update testdata * Fix long second row issue * fix templating issues * Fix lib.typ issues * Update testdata * Fix clean_trailing_parts * Update test cv * update test cv * Update theme defaults * update schema and fix moderncv * Fix moderncv issues * Update testdata * Update testdata and examples * Fix issues about photo * Fix typst photo path issues * improve entry templates from yaml * add new locale * Rename writing tests doc * Update writing tests * Improve tests * Add more cli tests * Increase test coverage * Rename variant pydantic model generator * Improve tests * Update testdata and improve tests * Format, fix pre-commit errors * Fix scripts and update entry figures * Improve tests * Write docstrings of schema * Write schema docstrings * Setup api reference * Start working on new docs * Work on docs * Improve progress panel of render command * Finalize new docs index * Complete CLI docs * Work on YAML input structure page * Finalize user guide * Start working on developer guide * Improve api reference * Improve developer guide * Improve developer guide * Improve developer gide * Improve developer guide * Improve developer guide * Update developer guide * Improve developer guide * Improve developer guide * Improve developer guide * Developer guide first draft * update developer guide * Update examples * Update testdata * Handle wrong installation (rendercv instead of rendercv[full]) * Remove unnecessary files * Write set up vs code page * Update README.md * Change docs description * Compress design options gif * minor updates * Polish all the json schema descriptions * Update testdata and examples * Remove some emdashed from docs * Add whatsapp support * Add TestEscapeTypstCharacters to tests * Implement custom connections * Add page break before sections feature * Revert page break before sections feature * Rebase to main * Fix social network tests, update schema
91 lines
3.2 KiB
Markdown
91 lines
3.2 KiB
Markdown
---
|
|
toc_depth: 1
|
|
---
|
|
|
|
# CLI Reference
|
|
|
|
## `rendercv`
|
|
|
|
Show version:
|
|
|
|
```bash
|
|
rendercv --version
|
|
```
|
|
|
|
Show help:
|
|
|
|
```bash
|
|
rendercv --help
|
|
```
|
|
|
|
## `rendercv new`
|
|
|
|
Create a new CV YAML input file
|
|
|
|
```bash
|
|
rendercv new "John Doe"
|
|
```
|
|
|
|
### Options
|
|
|
|
| Option | Description |
|
|
| ----------------------------- | ---------------------------------------------------------------- |
|
|
| `--theme THEME` | Use a built-in theme: << available_themes >>. Default: `classic` |
|
|
| `--locale LOCALE` | Use a locale: << available_locales >>. Default: `english` |
|
|
| `--create-typst-templates` | Generate Typst template files for advanced customization |
|
|
| `--create-markdown-templates` | Generate Markdown template files for advanced customization |
|
|
|
|
## `rendercv render`
|
|
|
|
Render a CV from a YAML file.
|
|
|
|
```bash
|
|
rendercv render John_Doe_CV.yaml
|
|
```
|
|
|
|
### Options
|
|
|
|
All output paths are relative to the input file.
|
|
|
|
| Option | Short | Description |
|
|
| -------------------------- | --------- | -------------------------------------------------------- |
|
|
| `--watch` | `-w` | Re-render automatically when the YAML file changes |
|
|
| `--quiet` | `-q` | Suppress all output messages |
|
|
| `--design FILE` | `-d` | Load `design` field from a separate YAML file |
|
|
| `--locale-catalog FILE` | `-lc` | Load `locale` field from a separate YAML file |
|
|
| `--settings FILE` | `-s` | Load `rendercv_settings` field from a separate YAML file |
|
|
| `--pdf-path PATH` | `-pdf` | Custom path for PDF output |
|
|
| `--typst-path PATH` | `-typ` | Custom path for Typst source output |
|
|
| `--markdown-path PATH` | `-md` | Custom path for Markdown output |
|
|
| `--html-path PATH` | `-html` | Custom path for HTML output |
|
|
| `--png-path PATH` | `-png` | Custom path for PNG output |
|
|
| `--dont-generate-pdf` | `-nopdf` | Skip PDF generation |
|
|
| `--dont-generate-typst` | `-notyp` | Skip Typst generation (implies `-nopdf`, `-nopng`) |
|
|
| `--dont-generate-markdown` | `-nomd` | Skip Markdown generation (implies `-nohtml`) |
|
|
| `--dont-generate-html` | `-nohtml` | Skip HTML generation |
|
|
| `--dont-generate-png` | `-nopng` | Skip PNG generation |
|
|
|
|
|
|
### Overriding YAML values
|
|
|
|
Override any field in the YAML file from the command line:
|
|
|
|
```bash
|
|
rendercv render John_Doe_CV.yaml --cv.phone "+1-555-555-5555"
|
|
```
|
|
|
|
```bash
|
|
rendercv render John_Doe_CV.yaml --cv.sections.education.0.institution "MIT"
|
|
```
|
|
|
|
Useful for keeping sensitive information (phone, address) out of version control.
|
|
|
|
## `rendercv create-theme`
|
|
|
|
Create a custom theme with Typst templates you can modify.
|
|
|
|
```bash
|
|
rendercv create-theme "mytheme"
|
|
```
|
|
|
|
Creates a `mytheme/` directory in the current folder with all template files. |