Skip to content

Command Line Usage

Lane.Wei edited this page Nov 27, 2023 · 2 revisions

Command manual

Usage: bambu-studio [ OPTIONS ] [ file.3mf/file.stl ... ]

OPTIONS:

  • --debug level
      Sets debug logging level. 0:fatal, 1:error, 2:warning, 3:info, 4:debug, 5:trace
  • --load-filaments "filament1.json;filament2.json;..."
      Load filament settings from the specified file list, the filament setting count should not exceed the filaments used in the 3mf.
    the config file should be a full config instead of the one used in resources/profiles/BBL/filament, example filament.json
  • --load-settings "machine.json;process.json"
      Load machine/process settings from the specified file, up to 1 machine setting and 1 process setting supported.
    the config file should be a full config instead of the one used in resources/profiles/BBL/machine, or resources/profiles/BBL/process, example process.json, machine.json
  • --outputdir dir
      Output directory for the exported files.
  • --arrange option
      Arrange options: 0-disable, 1-enable, others-auto
  • --orient
      Orient the model
  • --scale factor
      Scale the model by a float factor
  • --export-3mf filename.3mf
      Export project as 3MF.
  • --export-settings settings.json
      Export settings to a file.
  • --export-slicedata slicing_data_directory
      Export slicing data to a folder.
  • --help, -h
      Show command help.
  • --info
      Output the model's information.
  • --load-slicedata slicing_data_directory
      Load cached slicing data from directory
  • --pipe pipename
      Send progress to pipe.
  • --slice plate_index
      Slice the plates: 0-all plates, i-plate i, others-invalid
  • --uptodate
      Update the configs values of 3mf to latest automatically.

There are three ways to input settings:

  1. setting values from the command line (highest priority)
    --key=value, for example: --curr-bed-type="Cool Plate"
  2. setting values loaded with --load_settings and --load_filaments
  3. setting values loaded from 3mf(lowest priority)

The most common usage for slicing

there are three most commonly used cases for slicing:

Use case Detailed description Command Comments
Slice 3mf directly Using the printer/filament/print settings included in the 3mf ./bambu-studio --slice 0 --debug 2 --export-3mf output.3mf test_data/moon.3mf Slicing all the plates in moon.3mf, export the result to output.3mf
Slice 3mf with specific settings Using the printer/filament/print settings included in command line ./bambu-studio --curr-bed-type "Cool Plate" --load-settings "test_data/machine.json;test_data/process.json" --load-filaments "filament1.json;;filament3.json;filament4;;" --slice 2 --debug 2 --export-3mf output.3mf test_data/moon.3mf Slicing plate 2 in moon.3mf, export the result to output.3mf, using the test_data/machine.json to replace all the printer settings in 3mf, using test_data/process.json to replace all the print settings in 3mf, using filament1.json to replace the filament-1's setting in 3mf, using filament3.json to replace the filament-3's setting in 3mf, using filament4.json to replace the filament-4's setting in 3mf, keep the filament-2/5's setting in 3mf.
Slice stls Using the settings included in command line ./bambu-studio --orient --arrange 1 --load-settings "test_data/machine.json;test_data/process.json" --load-filaments "test_data/filament.json" --slice 2 --debug 2 --export-3mf output.3mf test_data/boat.stl Using test_data/machine.json for printer setting, Using test_data/process.json for print setting, Using test_data/filament.json for filament setting, orient and arrange before slicing
Clone this wiki locally