CLI Reference

layerforge

Entry point for the CLI.

This function wraps all the logic for processing an STL file and generating SVG slices while accepting commandline arguments.

Parameters

stl_file : str The path to the STL file. layer_height : float The height of each layer that is sliced from the model. output_folder : str The output folder for slice files in SVG format. scale_factor : float, optional The scale factor to apply to the model before slicing. target_height : float, optional The target height for the model before slicing.

Returns

None

Usage:

layerforge [OPTIONS]

Options:

  --stl-file TEXT            The path to the STL file.
  --layer-height FLOAT       The layer height.
  --output-folder TEXT       The output folder for SVG files.
  --scale-factor FLOAT       The scale factor to apply to the model.
  --target-height FLOAT      The target height for the model.
  --mark-tolerance FLOAT     Tolerance when matching existing marks. See
                             docs/reference_mark_algorithm.md#parameter-
                             effects.
  --mark-min-distance FLOAT  Minimum distance from contours and between marks.
                             See docs/reference_mark_algorithm.md#parameter-
                             effects.
  --available-shapes TEXT    Comma separated list of mark shapes. See
                             docs/reference_mark_algorithm.md#parameter-
                             effects.
  --mark-angle FLOAT         Default mark orientation in degrees. See
                             docs/reference_mark_algorithm.md#parameter-
                             effects.
  --mark-color TEXT          Outline color for marks. See
                             docs/reference_mark_algorithm.md#parameter-
                             effects.
  --help                     Show this message and exit.