Skip to content

autory

Usage:  [OPTIONS] COMMAND [ARGS]...

   █████╗ ██╗   ██╗████████╗ ██████╗ ██████╗ ██╗   ██╗
  ██╔══██╗██║   ██║╚══██╔══╝██╔═══██╗██╔══██╗╚██╗ ██╔╝
  ███████║██║   ██║   ██║   ██║   ██║██████╔╝ ╚████╔╝
  ██╔══██║██║   ██║   ██║   ██║   ██║██╔══██╗  ╚██╔╝
  ██║  ██║╚██████╔╝   ██║   ╚██████╔╝██║  ██║   ██║
  ╚═╝  ╚═╝ ╚═════╝    ╚═╝    ╚═════╝ ╚═╝  ╚═╝   ╚═╝

Version: v3.0.0-beta7

Options:
  --ui [text|graphical|headless]  The user interface mode.

                                  text: Text-based user interface. If Autory
                                  needs to ask for input, it should happen in
                                  the terminal window from which the command
                                  was run. Most output should also appear on
                                  the terminal (except for some Excel / VBA
                                  popups which we can't control).

                                  graphical: Graphical user interface. If
                                  Autory needs to ask for input, it should
                                  happen in a graphical popup window. Some
                                  things may still be written to the terminal
                                  window from which the command was run. This
                                  will go unseen if there is no terminal
                                  window (e.g. if the command was run from a
                                  shortcut).

                                  headless: No user interface. Autory will
                                  never ask for input. Progress bars are
                                  disabled. This is useful for running autory
                                  in a script or in a CI/CD pipeline. Most
                                  output should also appear on the terminal
                                  (except for some Excel / VBA popups which we
                                  can't control).

                                  [default: text]
  --log-level [debug|info|warning|error|critical]
                                  The level of logging for the `stderr`
                                  output. DEBUG is the most verbose, and
                                  CRITICAL is the least verbose.  [default:
                                  INFO]
  --profile / --dont-profile      Whether to profile the code execution. A
                                  statistics file will be written to the log
                                  directory, which may be opened using a tool
                                  like `snakeviz` (GUI) or `pstats` (CLI).
                                  This is useful for figuring out why a
                                  specific command is slow.  [default: dont-
                                  profile]
  --pause [never|always|onerror]  Whether to pause the CLI after execution.
                                  This is useful for debugging, and when
                                  calling the CLI from GUIs.

                                  never: Never pause after execution.

                                  always: Always pause after execution. The
                                  program will wait for the user to press a
                                  key before exiting.

                                  onError: Only pause if there was an error
                                  during execution. The program will wait for
                                  the user to press a key before exiting.

                                  [default: never]
  --help                          Show this message and exit.

Commands:
  convert   Perform various file type conversions related to Autory...
  debug     Print debugging information.
  draw      Visualize an Autory model.
  help      Command for getting help with Autory.
  inspect   Print human-readable details about an Autory model.
  new       Create new files from templates.
  patch     Patch outdated Excel workbook models to make them compatible...
  run       Run one or more Autory models.
  settings  Autory user settings (note: experimental interface).
  test      Autory test utilities.
  vcs       Autory Version Control System.
  version   Print the Autory version.
  view      View files using specialized user interfaces.

Subcommands