List of commands
Note: As of March 27th 2023 this documentation is out of date and is no longer being maintained. Up-to-date documentation is now included in the PFTrack and PFClean software installers
A full list of command line arguments can be found by running PFClean from the terminal with the "-help" command, i.e.:
"C:\Program Files\The Pixel Farm\PFClean\PFClean.exe" -help
The output from running -help
is copied below for your
reference:
Project:
-new_project /path/to/project/directory
-new_project_params /path/to/project/directory /path/to/params.xml
-load_project /path/to/project/file
-load_or_new_project /path/to/project/file
-load_or_new_project_params /path/to/project/file /path/to/params.xml
Media:
-new_scene name
-import /path/to/footage
-import_params /path/to/footage /path/to/params.xml
-cut CLIP_IDENTIFIER
-cut_params CLIP_IDENTIFIER /path/to/params.xml
-list_clips
-list_sequences
-list_scenes
-delete_clip CLIP_IDENTIFIER
-delete_clip_if_exists CLIP_IDENTIFIER
-delete_sequence sequence
-delete_sequence_if_exists sequence
-delete_sequence_if_empty sequence
-delete_sequence_if_empty_if_exists sequence
-delete_scene scene
-delete_scene_if_exists scene
-delete_scene_if_empty scene
-delete_scene_if_empty_if_exists scene
Effects:
-add_effect CLIP_IDENTIFIER /path/to/effect.xml
Export:
-export CLIP_IDENTIFIER
-export_params CLIP_IDENTIFIER /path/to/params.xml
Miscellaneous:
-dont_save_settings
-keep_job
-no_wait
-retry
-exit
where CLIP_IDENTIFIER= /full/path/to/footage | clip_name | ID | scene_name | sequence_name | all