.. Automatically generated by KiBot, please don't edit this file .. index:: pair: Files copier; copy_files Files copier ~~~~~~~~~~~~ Used to copy files to the output directory. Useful when an external tool is used to compress the output directory. |br| Note that you can use the `compress` output to create archives Type: ``copy_files`` Parameters: - **comment** :index:`: ` [string=''] A comment for documentation purposes. It helps to identify the output. - **dir** :index:`: ` [string='./'] Output directory for the generated files. If it starts with `+` the rest is concatenated to the default dir. - **name** :index:`: ` [string=''] Used to identify this particular output definition. Avoid using `_` as first character. These names are reserved for KiBot. - **options** :index:`: ` [dict] Options for the `copy_files` output. - Valid keys: - **download** :index:`: ` [boolean=true] Downloads missing 3D models from KiCad git. Only applies to models in KISYS3DMOD and KICAD6_3DMODEL_DIR. They are downloaded to a temporal directory and discarded. If you want to cache the downloaded files specify a directory using the KIBOT_3D_MODELS environment variable. - **files** :index:`: ` [list(dict)] Which files will be included. - Valid keys: - **source** :index:`: ` [string='*'] File names to add, wildcards allowed. Use ** for recursive match. By default this pattern is applied to the current working dir. See the `from_outdir` option. - **source_type** :index:`: ` [string='files'] [files,out_files,output,3d_models] How to interpret `source`. `files`: is a pattern for files relative to the working directory. `out_files`: is a pattern for files relative to output dir specified with `-d` command line option. `output`: is the name of an `output`. `3d_models`: is a pattern to match the name of the 3D models extracted from the PCB.. - ``dest`` :index:`: ` [string=''] Destination directory inside the output dir, empty means the same of the file relative to the source directory. For the `3d_models` type you can use DIR+ to create subdirs under DIR. - ``filter`` :index:`: ` [string='.*'] A regular expression that source files must match. - ``save_pcb`` :index:`: ` [boolean=false] Only usable for the `3d_models` mode. Save a PCB copy modified to use the copied 3D models. - **no_virtual** :index:`: ` [boolean=false] Used to exclude 3D models for components with 'virtual' attribute. - ``dnf_filter`` :index:`: ` [string|list(string)='_none'] Name of the filter to mark components as not fitted. A short-cut to use for simple cases where a variant is an overkill. - ``follow_links`` :index:`: ` [boolean=true] Store the file pointed by symlinks, not the symlink. - ``kicad_3d_url`` :index:`: ` [string='https://gitlab.com/kicad/libraries/kicad-packages3D/-/raw/master/'] Base URL for the KiCad 3D models. - ``kicad_3d_url_suffix`` :index:`: ` [string=''] Text added to the end of the download URL. Can be used to pass variables to the GET request, i.e. ?VAR1=VAL1&VAR2=VAL2. - ``link_no_copy`` :index:`: ` [boolean=false] Create symlinks instead of copying files. - ``pre_transform`` :index:`: ` [string|list(string)='_none'] Name of the filter to transform fields before applying other filters. A short-cut to use for simple cases where a variant is an overkill. - ``variant`` :index:`: ` [string=''] Board variant to apply. - **type** :index:`: ` [string=''] Type of output. - ``category`` :index:`: ` [string|list(string)=''] The category for this output. If not specified an internally defined category is used. Categories looks like file system paths, i.e. **PCB/fabrication/gerber**. The categories are currently used for `navigate_results`. - ``disable_run_by_default`` :index:`: ` [string|boolean] Use it to disable the `run_by_default` status of other output. Useful when this output extends another and you don't want to generate the original. Use the boolean true value to disable the output you are extending. - ``extends`` :index:`: ` [string=''] Copy the `options` section from the indicated output. Used to inherit options from another output of the same type. - ``groups`` :index:`: ` [string|list(string)=''] One or more groups to add this output. In order to catch typos we recommend to add outputs only to existing groups. You can create an empty group if needed. - ``output_id`` :index:`: ` [string=''] Text to use for the %I expansion content. To differentiate variations of this output. - ``priority`` :index:`: ` [number=11] [0,100] Priority for this output. High priority outputs are created first. Internally we use 10 for low priority, 90 for high priority and 50 for most outputs. - ``run_by_default`` :index:`: ` [boolean=true] When enabled this output will be created when no specific outputs are requested.