Skip to main content

Upgrading from v0 to v1

The CloudBase CLI v1 version has been planned for a long time. In v1, we have completely changed how commands are used, simplified the syntax of some commands, and aligned with more standard specifications. This is also the direction of our future development efforts: to provide users with a simpler and more powerful CLI tool.

Meanwhile, the CloudBase CLI v1 version remains fully compatible with the command usage in CloudBase v0. You need not worry about potential issues arising from the upgrade, as this is not a breaking or incompatible update. Nevertheless, we still recommend adopting the new commands, which represent the future direction of development.

Upgrade to v3?

If you are upgrading from v1/v2 to v3, see Upgrading from v1/v2 to v3.

Upgrade Procedure​

  1. Uninstall the old version
npm uninstall -g @cloudbase/cli
  1. Install the new version
npm i -g @cloudbase/cli

Upgrade Notes​

tcb Command​

In v1, we introduced the tcb command, which can create and deploy TCB projects with one click.

Command Format Changes​

In the v1 version, all commands changed from the env:list format to the env list format, meaning all : symbols in commands were replaced with spaces. This helps us merge similar commands, provide a simpler and more understandable command help prompt, and also conforms to most command usage habits, reducing the learning curve.

Command Name Changes​

  1. The original functions command has been changed to the shorter fn command, such as tcb fn list.
  2. The original cloud access service command has been changed to the access command.

Removal of Programmatic APIs​

In the v1 version, we have completely removed the programmatic use of the CLI. If you need to operate TCB resources as an administrator, please use the @cloudbase/manager-node SDK.