Update README.md

README.md

@@ -25,7 +25,67 @@ First, install the AniPortrait package into your python environment. If you're c
 pip install git+https://github.com/painebenjamin/aniportrait.git
 ```
 
-Now, you can create the pipeline, automatically pulling the weights from this repository, either as individual models:
+## Command-Line
+
+A command-line utilitiy `aniportrait` is installed with the package.
+
+```sh
+Usage: aniportrait [OPTIONS] INPUT_IMAGE
+
+  Run AniPortrait on an input image with a video, and/or audio file. - When
+  only a video file is provided, a video-to-video (face reenactment) animation
+  is performed. - When only an audio file is provided, an audio-to-video (lip-
+  sync) animation is performed. - When both a video and audio file are
+  provided, a video-to-video animation is performed with the audio as guidance
+  for the face and mouth movements.
+
+Options:
+  -v, --video FILE                Video file to drive the animation.
+  -a, --audio FILE                Audio file to drive the animation.
+  -fps, --frame-rate INTEGER      Video FPS. Also controls the sampling rate
+                                  of the audio. Will default to the video FPS
+                                  if a video file is provided, or 30 if not.
+  -cfg, --guidance-scale FLOAT    Guidance scale for the diffusion process.
+                                  [default: 3.5]
+  -ns, --num-inference-steps INTEGER
+                                  Number of diffusion steps.  [default: 20]
+  -cf, --context-frames INTEGER   Number of context frames to use.  [default:
+                                  16]
+  -co, --context-overlap INTEGER  Number of context frames to overlap.
+                                  [default: 4]
+  -nf, --num-frames INTEGER       An explicit number of frames to use. When
+                                  not passed, use the length of the audio or
+                                  video
+  -s, --seed INTEGER              Random seed.
+  -w, --width INTEGER             Output video width. Defaults to the input
+                                  image width.
+  -h, --height INTEGER            Output video height. Defaults to the input
+                                  image height.
+  -m, --model TEXT                HuggingFace model name.
+  -nh, --no-half                  Do not use half precision.
+  -g, --gpu-id INTEGER            GPU ID to use.
+  -sf, --single-file              Download and use a single file instead of a
+                                  directory.
+  -cf, --config-file TEXT         Config file to use when using the single-
+                                  file option. Accepts a path or a filename in
+                                  the same directory as the single file. Will
+                                  download from the repository passed in the
+                                  model option if not provided.  [default:
+                                  config.json]
+  -mf, --model-filename TEXT      The model file to download when using the
+                                  single-file option.  [default:
+                                  aniportrait.safetensors]
+  -rs, --remote-subfolder TEXT    Remote subfolder to download from when using
+                                  the single-file option.
+  -c, --cache-dir DIRECTORY       Cache directory to download to. Default uses
+                                  the huggingface cache.
+  -o, --output FILE               Output file.  [default: output.mp4]
+  --help                          Show this message and exit.
+```
+
+## Python
+
+You can create the pipeline, automatically pulling the weights from this repository, either as individual models:
 
 ```py
 from aniportrait import AniPortraitPipeline