aestream / faery

GNU Lesser General Public License v3.0
5 stars 0 forks source link

Fix a CLI API #11

Open Jegp opened 2 days ago

Jegp commented 2 days ago

The current command-line interface is in a state of flux. We should consolidate on an API that is both simple and easy to use while supporting the stream-based API (with inputs, filters, outputs - including renderers).

User stories

Jegp commented 2 days ago

Possible ideas for CLI APIs

I/O centric: faery input file x.aedat4 filter time_slice filter denoise output file y.mp4 I/O centric 2: faery [--input file x.aedat4] [! time time_slice x] [--output file y.mp4] Task centric: faery render -i x.aedat4 -o y.mp4 Object centric: faery 'open_camera(...).filter(...)'

Alternative commands

Default: faery [--input file x.aedat4] [! time time_slice x] [--output file y.mp4] Colormaps: faery colormaps ... Generate template script: faery template ...