media-inspector

Find media files by searching in the metadata

• Requirements
• Supported media mime-types
• Usage
• Commands
• How filters work
• Notes
• Test files

Requirements

• Node 10 or newer
• mediainfo executable in $PATH

Supported media mime-types

The current list of supported mime-types is

• video/

However, as Mediainfo is utilised for reading the metadata, it should be fairly simple to expand that to include both audio and image/.

Usage

$ npm install -g media-inspector
$ media-inspector COMMAND
running command...
$ media-inspector (-v|--version|version)
media-inspector/0.4.2 darwin-x64 node-v14.14.0
$ media-inspector --help [COMMAND]
USAGE
  $ media-inspector COMMAND
...

Commands

• media-inspector autocomplete [SHELL]
• media-inspector cache
• media-inspector help [COMMAND]
• media-inspector inspect
• media-inspector validate-filter FILTERPATH

media-inspector autocomplete [SHELL]

display autocomplete installation instructions

USAGE
  $ media-inspector autocomplete [SHELL]

ARGUMENTS
  SHELL  shell type

OPTIONS
  -r, --refresh-cache  Refresh cache (ignores displaying instructions)

EXAMPLES
  $ media-inspector autocomplete
  $ media-inspector autocomplete bash
  $ media-inspector autocomplete zsh
  $ media-inspector autocomplete --refresh-cache

See code: @oclif/plugin-autocomplete

media-inspector cache

Cache a directory structure as JSON

USAGE
  $ media-inspector cache

OPTIONS
  -r, --read=read    (required) Path of a directory to read
  -w, --write=write  (required) Path of where to write the cache as JSON

EXAMPLES
  $ media-inspector cache ~/Downloads downloads.json
  $ media-inspector cache /Users/username/Downloads ~/Desktop/downloads.json

See code: src/cli/commands/cache.ts

media-inspector help [COMMAND]

display help for media-inspector

USAGE
  $ media-inspector help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

media-inspector inspect

Inspect input with filter

USAGE
  $ media-inspector inspect

OPTIONS
  -f, --filter=filter     (required) Path of the filter to apply in JSON or JSON5
  -i, --includeAuxiliary  Will also include empty directories and 'container' directories
  -r, --read=read         (required) Path of a directory or cache file to read

  -v, --verbose           Enable to get progress and detailed information on matches. By default only matched absolute
                          paths are logged, so the output can be piped

See code: src/cli/commands/inspect.ts

media-inspector validate-filter FILTERPATH

Validate filter

USAGE
  $ media-inspector validate-filter FILTERPATH

ARGUMENTS
  FILTERPATH  Path to filter in JSON or JSON5

EXAMPLE
  $ media-inspector validate-filter ./examples/filter-default.json5

See code: src/cli/commands/validate-filter.ts

How filters work

A filter is a list of rules. A rule is a prioritised list of conditions. A rule is considered satisfied when all its conditions are satisfied. When a media file satisfies all the conditions of any rule, that media-file is considered a match.

Notes

• https://github.com/jshttp/mime-types#readme
• https://github.com/mgcrea/node-mediainfo-parser

Test files

https://www.sample-videos.com/about.php