Migrating From v1 to v2

Note

Fovus CLI v1 is deprecated. Support for v1 will end on December 31, 2024. We recommend updating to v2 as soon as possible using pip install --upgrade fovus.

Fovus CLI v2 is a major update from v1. This guide will help you migrate your existing v1 scripts and workflow to v2.

Flag Naming Conventions

Most flags with abbreviations have been removed in favor of more descriptive flags. Flags in camelCase have been removed as well. All flags now follow dash-case.

For example, the flag --computing-device, --computingDevice, -cd in v1 is now only --computing-device in v2.

Common Options

  • --silence, -s: This flag must be used directly after the fovus command to disable interactive output. For example, fovus -s projects list will work but fovus projects list -s will not.

  • --include-input, --includeInput, -ii: This flag is replaced with --include-paths.

  • --include-output, --includeOutput, -io: This flag is replaced with --include-paths.

  • --exclude-input, --excludeInput, -ei: This flag is replaced with --exclude-paths.

  • --exclude-output, --excludeOutput, -eo: This flag is replaced with --exclude-paths.

Commands

Positional Arguments

Critical options that were previously defined as flags are now positional arguments. For example, in fovus job create, --job-config-file-path, --jobConfigFilePath, -jcfp is now the first positional argument and --job-file-root-directory, --jobFileRootDirectory, -jfrd is the second.

Instead of running:

fovus job create --job-config-file-path /path/to/job-config.json --job-file-root-directory /path/to/job-files

You will now run:

fovus job create /path/to/job-config.json /path/to/job-files

Options that are not listed as positional arguments are the same as v1 except Flag Naming Conventions applies.

v1 to v2 Command Translation

  • --login, -l → fovus auth login

  • --logout, -lo → fovus auth logout

  • --user, -u → fovus auth user

  • --open-config-folder, --openConfigFolder, -ocf → fovus config open

  • --create-job-with-upload, --createJobWithUpload, -cjwu → fovus job create

    • --job-config-file-path, --jobConfigFilePath, -jcfp → Positional Argument 1

    • --job-file-root-directory, --jobFileRootDirectory, -jfrd → Positional Argument 2

  • --delete-job, --deleteJob, -dj → fovus job delete

    • --job-id, --jobId, -jid → Positional Argument 1

    • --job-id-list, --jobIdList, -jidl → Any subsequent positional arguments

  • --download-job-files, --downloadJobFiles, -djf → fovus job download

    • --job-file-root-directory, --jobFileRootDirectory, -jfrd → Positional Argument 1

  • --live-tail-file, --liveTailFile, -ltf → fovus job live-tail

    • --live-tail-file, --liveTailFile, -ltf → Positional Argument 1

  • --get-job-current-status, --getJobCurrentStatus, -gjcs → fovus job status

  • --sync-job-files, --syncJobFiles, -sjf → fovus job sync

  • --list-projects, --listProjects, -lpr → fovus projects list

  • --mount-storage, --mountStorage, -ms → fovus storage mount

  • --unmount-storage, --unmountStorage, -us → fovus storage unmount

  • --upload-files, --uploadFiles, -uf → fovus storage upload

    • --local-path, --localPath, -lp → Positional Argument 1

    • --fovus-path, --fovusPath, -fp → Positional Argument 2 (optional)