Command Line Interface

This page contains an exhaustive list of all the commands available with manim-slides.

manim-slides

Manim Slides command-line utilities.

If no command is specified, defaults to present.

manim-slides [OPTIONS] COMMAND [ARGS]...

Options

--notify-outdated-version, -S, --silent

Check if a new version of Manim Slides is available.

-v, --version

Show the version and exit.

-h, --help

Show this message and exit.

convert

Convert SCENE(s) into a given format and writes the result in DEST.

manim-slides convert [OPTIONS] [SCENES]... DEST

Options

--folder <DIRECTORY>

Set slides folder.

Default:

slides

--to <FORMAT>

Set the conversion format to use. Use ‘auto’ to detect format from DEST.

Default:

auto

Options:

auto | html | pdf | pptx

--open

Open the newly created file using the appropriate application.

-f, --force

Overwrite any existing file.

-c, --config <config_options>

Configuration options passed to the converter. E.g., pass -cslide_number=true to display slide numbers.

--use-template <FILE>

Use the template given by FILE instead of default one. To echo the default template, use --show-template.

--show-template

Show the template (currently) used for a given conversion format and exit.

--show-config

Show supported options for given format and exit.

-v, --verbosity <verbosity>

Verbosity of CLI output.

Options:

DEBUG | INFO | WARNING | ERROR | CRITICAL

Arguments

SCENES

Optional argument(s)

DEST

Required argument

Environment variables

MANIM_SLIDES_VERBOSITY

Provide a default for -v

init

Initialize a new default configuration file.

manim-slides init [OPTIONS]

Options

-m, --merge

Merge any existing configuration file with the new configuration.

-f, --force

Overwrite any existing configuration file.

-c, --config <FILE>

Set path to configuration file.

Default:

.manim-slides.toml

-h, --help

Show this message and exit.

-v, --verbosity <verbosity>

Verbosity of CLI output.

Options:

DEBUG | INFO | WARNING | ERROR | CRITICAL

Environment variables

MANIM_SLIDES_VERBOSITY

Provide a default for -v

list-scenes

List available scenes.

manim-slides list-scenes [OPTIONS]

Options

--folder <DIRECTORY>

Set slides folder.

Default:

slides

-h, --help

Show this message and exit.

-v, --verbosity <verbosity>

Verbosity of CLI output.

Options:

DEBUG | INFO | WARNING | ERROR | CRITICAL

Environment variables

MANIM_SLIDES_VERBOSITY

Provide a default for -v

present

Present SCENE(s), one at a time, in order.

Each SCENE parameter must be the name of a Manim scene, with existing SCENE.json config file.

You can present the same SCENE multiple times by repeating the parameter.

Use manim-slide list-scenes to list all available scenes in a given folder.

manim-slides present [OPTIONS] [SCENES]...

Options

-c, --config <FILE>

Set path to configuration file.

Default:

.manim-slides.toml

--folder <DIRECTORY>

Set slides folder.

Default:

slides

--start-paused

Start paused.

-F, --full-screen, --fullscreen

Toggle full screen mode.

-s, --skip-all

Skip all slides, useful the test if slides are working. Automatically sets --exit-after-last-slide to True.

--exit-after-last-slide

At the end of last slide, the application will be exited.

-H, --hide-mouse

Hide mouse cursor.

--aspect-ratio <aspect_ratio>

Set the aspect ratio mode to be used when rescaling the video.

Default:

keep

Options:

keep | ignore

--sa, --start-at <SCENE,SLIDE>

Start presenting at (x, y), equivalent to --sacn x --sasn y, and overrides values if not None.

--sacn, --start-at-scene-number <INDEX>

Start presenting at a given scene number (0 is first, -1 is last).

--sasn, --start-at-slide-number <INDEX>

Start presenting at a given slide number (0 is first, -1 is last).

-S, --screen <NUMBER>

Present content on the given screen (a.k.a. display).

--playback-rate <RATE>

Playback rate of the video slides, see PySide6 docs for details. The playback rate of each slide is defined as the product of its default playback rate and the provided value.

--next-terminates-loop

If set, pressing next will turn any looping slide into a play slide.

--hide-info-window

Hide info window.

--info-window-screen <NUMBER>

Put info window on the given screen (a.k.a. display).

-h, --help

Show this message and exit.

-v, --verbosity <verbosity>

Verbosity of CLI output.

Options:

DEBUG | INFO | WARNING | ERROR | CRITICAL

Arguments

SCENES

Optional argument(s)

Environment variables

MANIM_SLIDES_VERBOSITY

Provide a default for -v

render

Render SCENE(s) from the input FILE, using the specified renderer.

Use manim-slides render --help to see help information for a specific renderer.

manim-slides render [-h] [--CE|--GL] [RENDERER_ARGS]...

Options

--CE

If set, use Manim Community Edition (CE) renderer. If this or --GL is not set, defaults to CE renderer.

--GL

If set, use ManimGL renderer.

Arguments

[RENDERER_ARGS]...

Optional argument(s)

Environment variables

MANIM_RENDERER

Provide a default for --CE

MANIMGL_RENDERER

Provide a default for --GL

wizard

Launch configuration wizard.

manim-slides wizard [OPTIONS]

Options

-m, --merge

Merge any existing configuration file with the new configuration.

-f, --force

Overwrite any existing configuration file.

-c, --config <FILE>

Set path to configuration file.

Default:

.manim-slides.toml

-h, --help

Show this message and exit.

-v, --verbosity <verbosity>

Verbosity of CLI output.

Options:

DEBUG | INFO | WARNING | ERROR | CRITICAL

Environment variables

MANIM_SLIDES_VERBOSITY

Provide a default for -v