egaia list¶
List all the files in the current collection. Optionally filter the list of file paths to include only tagged or untagged files. The output of this utility is intended to be piped into other tools, notably “egaia tag”.
Usage¶
egaia list --help
egaia list --items
egaia list --count
egaia list [ --files ] [ --dirs ] [ --filter=FILTER ] [ --uuid=UUID ]
[ --exclude=EXCLUDE... ]
Options¶
--help
- Show this help text and exit.
--items
- List the items in the collection (i.e., a list of UUIDs).
--files
- List the files included in the collection.
--dirs
- List the “file-like” directories included in the collection: directories
with the suffix
.dir
or.vclips
. Each directory of this type is treated as an indivisible logical unit by egaia, so the files within it are not tagged. --filter=FILTER
- Filter output to include only files of a certain type. The FILTER can be either a string that matches any part of the file type tag (e.g., “df” or “df-thumb”), or one of three special filters: “tagged”, “untagged”, and “originals”.
--uuid=UUID
- List all files matching the given UUID.
--exclude=EXCLUDE...
- Exclude files whose names match the pattern given. EXCLUDE should be a string that will be matched against any part of the filename.
--count
- Provide a count of the number of items in the collection.
Sample filters¶
tagged
- files with a UUID tag
untagged
- files without UUID tag
originals
- original files (tagged)
metadata
- metadata files
df
- all distribution formats
pf
- all preservation formats
df-thumb
- thumbnail images