130 lines
5.4 KiB
ReStructuredText
130 lines
5.4 KiB
ReStructuredText
Commandline usage
|
|
=================
|
|
|
|
After installation_, ``bat --help`` will show you general usage instructions.
|
|
The command structure is::
|
|
|
|
bat [common options] {subcommand} [subcommand-specific options]
|
|
|
|
The common options are all optional::
|
|
|
|
-p, --profile Run the profiler, write to bam.prof
|
|
-v, --verbose Log INFO level and higher
|
|
-d, --debug Log everything
|
|
-q, --quiet Log at ERROR level and higher
|
|
|
|
For most users only ``--verbose`` is useful, the other options can be very
|
|
helpful during development or debugging.
|
|
|
|
Logging is sent to ``stderr``, whereas regular output is sent to ``stdout``.
|
|
|
|
The available subcommands are described in the next sections. Each subcommand
|
|
also takes a ``--help`` argument to get specific usage instructions.
|
|
|
|
|
|
List
|
|
----
|
|
|
|
The ``bat list`` command lists the dependencies of a blend file. When there are
|
|
no dependencies, it outputs nothing. Example::
|
|
|
|
% bat list tests/blendfiles/doubly_linked.blend
|
|
tests/blendfiles/doubly_linked.blend
|
|
tests/blendfiles/linked_cube.blend
|
|
tests/blendfiles/material_textures.blend
|
|
tests/blendfiles/linked_cube.blend
|
|
tests/blendfiles/basic_file.blend
|
|
tests/blendfiles/material_textures.blend
|
|
tests/blendfiles/textures/Bricks/brick_dotted_04-bump.jpg
|
|
tests/blendfiles/textures/Bricks/brick_dotted_04-color.jpg
|
|
|
|
By passing the ``--json`` option it outputs to JSON rather than plain text::
|
|
|
|
{
|
|
"/path/to/blender-asset-tracer/tests/blendfiles/material_textures.blend": [
|
|
"/path/to/blender-asset-tracer/tests/blendfiles/textures/Bricks/brick_dotted_04-bump.jpg",
|
|
"/path/to/blender-asset-tracer/tests/blendfiles/textures/Bricks/brick_dotted_04-color.jpg"
|
|
],
|
|
"/path/to/blender-asset-tracer/tests/blendfiles/linked_cube.blend": [
|
|
"/path/to/blender-asset-tracer/tests/blendfiles/basic_file.blend"
|
|
],
|
|
"/path/to/blender-asset-tracer/tests/blendfiles/doubly_linked.blend": [
|
|
"/path/to/blender-asset-tracer/tests/blendfiles/linked_cube.blend",
|
|
"/path/to/blender-asset-tracer/tests/blendfiles/material_textures.blend"
|
|
]
|
|
}
|
|
|
|
Note that in this case all paths are absolute, whereas the regular output shows
|
|
paths relative to the current working directory.
|
|
|
|
|
|
Pack
|
|
----
|
|
|
|
The ``bat pack`` command takes the dependencies as shown by ``bat list`` and
|
|
copies them to a target. This target can be a directory, a ZIP file, or
|
|
S3-compatible storage::
|
|
|
|
bat pack [-h] [-p PROJECT] [-n] [-e [EXCLUDEs] blendfile target
|
|
|
|
The optional arguments influence the manner of packing::
|
|
|
|
-p PROJECT, --project PROJECT
|
|
Root directory of your project. Paths to below this
|
|
directory are kept in the BAT Pack as well, whereas
|
|
references to assets from outside this directory will
|
|
have to be rewitten. The blend file MUST be inside the
|
|
project directory. If this option is ommitted, the
|
|
directory containing the blend file is taken as the
|
|
project directoy.
|
|
-n, --noop Don't copy files, just show what would be done.
|
|
-e [EXCLUDEs, --exclude [EXCLUDEs]
|
|
Space-separated list of glob patterns (like '*.abc')
|
|
to exclude.
|
|
|
|
For more information see the chapter :ref:`packing`.
|
|
|
|
|
|
Pack folder
|
|
-----------
|
|
|
|
The ``bat pack-folder`` command scans a directory tree, collects every
|
|
``.blend`` file in it, traces the dependencies of all of them, and packs the
|
|
whole lot into a single target. Assets used by more than one blend file are
|
|
only stored once::
|
|
|
|
bat pack-folder [-h] -t TARGET [-p PROJECT] [-n] [-e [EXCLUDE ...]] [-c]
|
|
[-r] [--keep-hierarchy] [--latest-only] [--follow-symlinks]
|
|
[--ignore-dir [GLOB ...]] [--no-validate] folder
|
|
|
|
For example, to zip up a project's work directory::
|
|
|
|
bat pack-folder /z/projects/garde_a_vue/work -t /tmp/gav_work.zip --latest-only
|
|
|
|
Backup files (``.blend1``, ``.blend2``, …) are never packed. By default the
|
|
scanned folder also acts as the project root, so the pack mirrors the folder's
|
|
own structure and assets referenced from outside it end up in
|
|
``_outside_project``. Use ``--keep-hierarchy`` to mirror the full filesystem
|
|
paths instead.
|
|
|
|
The options specific to this subcommand are::
|
|
|
|
-t TARGET, --target TARGET
|
|
Target directory or ZIP file (required).
|
|
--latest-only Of every 'name_vNNN.blend' version series in a
|
|
directory, only pack the highest version. Variants
|
|
like 'name_vNNN_light.blend' form their own series;
|
|
files without a version are always packed.
|
|
--follow-symlinks Descend into symlinked directories while scanning.
|
|
Already-visited directories are skipped, so symlink
|
|
loops are safe.
|
|
--ignore-dir [GLOB ...]
|
|
Globs of directory names to skip while scanning
|
|
(default: .* __pycache__).
|
|
--no-validate Don't check that each '.blend' file really is a
|
|
blend file. Faster, but a non-blend file will abort
|
|
the pack.
|
|
|
|
The other options (``-p``, ``-n``, ``-e``, ``-c``, ``-r``, ``--keep-hierarchy``)
|
|
mean the same as for ``bat pack``.
|