CLI Help Documentation¶
reprex --help
Usage: reprex [OPTIONS]
Render reproducible examples of Python code for sharing. Your code will be
executed and the results will be embedded as comments below their associated
lines.
By default, your system's default command-line text editor will open for you
to type or paste in your code. This editor can be changed by setting the
EDITOR environment variable. You can instead specify an input file with the
--infile / -i option
Additional markup will be added that is appropriate to the choice of venue
option. For example, for the default `gh` venue for GitHub Flavored Markdown,
the final reprex will look like:
----------------------------------------
```python
arr = [1, 2, 3, 4, 5]
[x + 1 for x in arr]
#> [2, 3, 4, 5, 6]
max(arr) - min(arr)
#> 4
```
<sup>Created at 2021-02-27 00:13:55 PST by
[reprexlite](https://github.com/jayqi/reprexlite) v0.3.1</sup>
----------------------------------------
The supported venue formats are:
- gh : GitHub Flavored Markdown
- so : StackOverflow, alias for gh
- ds : Discourse, alias for gh
- html : HTML
- py : Python script
- rtf : Rich Text Format
- slack : Slack
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --infile -i PATH Read code from an │
│ input file │
│ instead via │
│ editor. │
│ [default: None] │
│ --outfile -o PATH Write output to │
│ file instead of │
│ printing to │
│ console. │
│ [default: None] │
│ --venue -v [gh|so|ds|html|p Output format │
│ y|rtf|slack] appropriate to │
│ the venue where │
│ you plan to share │
│ this code. │
│ [default: gh] │
│ --advertise --no-advertise Whether to │
│ include footer │
│ that credits │
│ reprexlite. If │
│ unspecified, will │
│ depend on │
│ specified venue's │
│ default. │
│ [default: │
│ no-advertise] │
│ --session-info Whether to │
│ include details │
│ about session and │
│ installed │
│ packages. │
│ --style Autoformat code │
│ with black. │
│ Requires black to │
│ be installed. │
│ --comment TEXT Comment prefix to │
│ use for results │
│ returned by │
│ expressions. │
│ [default: #>] │
│ --old-results Keep old results, │
│ i.e., lines that │
│ match the prefix │
│ specified by the │
│ --comment option. │
│ If not using this │
│ option, then such │
│ lines are │
│ removed, meaning │
│ that an input │
│ that is a reprex │
│ will be │
│ effectively │
│ regenerated. │
│ --version Show reprexlite │
│ version and exit. │
│ --install-comple… Install │
│ completion for │
│ the current │
│ shell. │
│ --show-completion Show completion │
│ for the current │
│ shell, to copy it │
│ or customize the │
│ installation. │
│ --help Show this message │
│ and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯