1. fox CLI Usage

Every command, subcommand, their subcommands etc. support -h/--help to learn more about the possibilities to interact with the repository.

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

  Run the top-level ``fox.py`` command group.

  Args:     ctx: Click context for command dispatch and help rendering.
  show_config: If ``True``, print version/configuration information.

Options:
  --version          Show the version and exit.
  -s, --show-config  Shows foxBMS configuration information.
  -h, --help         Show this message and exit.

Commands:
  bms           Run the interactive BMS communication shell.
  bootloader    Bootloader command group entry point.
  ceedling      Run the ``ceedling`` unit testing tool.
  cli-unittest  Run unit-tests on the CLI tool itself.
  com-test      Communication command group entry point.
  db            Database command group entry point.
  etl           ETL command group entry point.
  gui           Run the graphical user interface.
  ide           Open one or more pre-configured VS Code workspaces.
  install       Installation information and instructions
  log           Log CAN traffic to rolling output files.
  misc          Miscellaneous command group entry point.
  plot          Generate plots from input data files or directories.
  pre-commit    Run the ``pre-commit`` tool with forwarded raw arguments.
  run-program   Run the provided program.
  run-script    Run the provided script.
  waf           Run the ``waf`` build tool.

1.1. Subcommands

fox.py usage documentation

• 1.1.1. bootloader
• 1.1.2. waf
• 1.1.3. bms
• 1.1.4. cli-unittest
• 1.1.5. com
• 1.1.6. db
• 1.1.7. ceedling
• 1.1.8. etl
• 1.1.9. gui
• 1.1.10. ide
• 1.1.11. install
• 1.1.12. log
• 1.1.13. Virtual Testing Platform
• 1.1.14. misc
• 1.1.15. plot
• 1.1.16. pre-commit
• 1.1.17. release
• 1.1.18. run-program
• 1.1.19. run-script

1.2. fox CLI package

Attention

Ensure that the virtual Python environment, which contains the fox CLI package, is activated before using it.

Note

The fox_cli directory within the user’s Documents directory will contain any data generated by the fox CLI package.

The fox CLI package is a condensed version of the fox CLI. Instead of using the shell wrappers, which only work within the repository, the fox-cli command is provided to interact with the package. This command is only accessible outside of the repository.

Win32Linux

fox-cli

The following subcommands are available in the fox CLI package:

Usage: fox-cli [OPTIONS] COMMAND [ARGS]...

  Run the top-level ``fox-cli`` command group.

  Args:     ctx: Click context for command dispatch and help rendering.
  show_config: If ``True``, print version/configuration information.

Options:
  --version          Show the version and exit.
  -s, --show-config  Shows foxBMS configuration information.
  -h, --help         Show this message and exit.

Commands:
  bms           Run the interactive BMS communication shell.
  bootloader    Bootloader command group entry point.
  com-test      Communication command group entry point.
  db            Database command group entry point.
  etl           ETL command group entry point.
  gui           Run the graphical user interface.
  log           Log CAN traffic to rolling output files.
  plot          Generate plots from input data files or directories.
  run-program   Run the provided program.
  run-script    Run the provided script.