Upgrading to cf CLI v8

Page last updated:

You can use Cloud Foundry Command Line Interface (cf CLI) v8 to interact with Cloud Foundry API (CAPI) V3. This topic describes the major changes between cf CLI v7 and cf CLI v8, and subsequent improvements added through later v8 releases.

The cf CLI development team aims to provide:

• A seamless upgrade experience from cf CLI v7. Changes are minimal. Where there are changes, the team has incorporated feedback from the community to simplify the cf CLI user experience.

• Details about potential breaking changes and alternative workflows for scripting environments.

To understand the differences between specific commands, see Command differences below.

For more information about CAPI V3, see the CAPI V3 documentation.

For the full list of cf CLI v8 releases, see Releases in the Cloud Foundry CLI repository on GitHub.

New workflows supported by cf CLI v8

Some key new features available through the cf CLI v8 are:

• Asynchronous service operations: All service-related operations are now asynchronous by default. This includes manipulating service keys and route bindings.

Install cf CLI v8

To install cf CLI v8, see Installing the cf CLI.

Prerequisites

The cf CLI v8 requires cf-deployment v16.11.0 or later.

For more information, see the cf CLI Versioning and Support Policy on GitHub.

Command differences

These sections describe changes in commands from cf CLI v7 to cf CLI v8. They also provide important information for those who use the cf CLI in scripts.

For information about possible breaking changes, see the Table of differences below. This table includes removed flag options, updated output, and removed or changed argument requirements.

Manifest differences

When you apply a manifest by running cf push, cf CLI v8 does not provide a manifest diff through the V3 manifest diff endpoint. This new endpoint supports version 1 manifests only. For more information, see Create a manifest diff for a space (experimental) in the CAPI documentation.

About scripting

If you have scripts that rely on the cf CLI, this section describes possible changes in cf CLI v8 that might affect scripts.

Some of these changes are:

• Style changes, including changes in the order or wording of the output.
• cf CLI v8 uses CAPI V3 to make requests related to services. CAPI V3 creates asynchronous jobs. If you want to continue to create jobs synchronously, use the new --wait flag.
• JSON response changes such as additional elements or nesting, which may impact parsing in existing scripts.

Table of differences

The following table summarizes how commands differ between cf CLI v7 and cf CLI v8, including improvements added in later v8 releases.