Canvas CLI updates ahead of the Canvas Platform upgrade

Canvas CLI 1.0.0 is here to get you ready for the Canvas Platform upgrade. Upgrade to Canvas CLI 1.0.0 or newer to get everything below, with pip install --upgrade canvas, or uv tool upgrade canvas if you installed it with uv.

sdk

What’s new #

  • More commands through Canvas Platform. Once you sign in with canvas login, the following commands go through Canvas Platform for the plugins and instances it manages, with no credentials.ini client needed: enable, disable, config list, config set, config unset, uninstall, list, logs, and the namespace commands. See which plugins and instances go through Canvas Platform.

  • Validation before every deploy. canvas deploy runs canvas validate before it pushes, so a plugin that wouldn’t load is caught on your machine. See canvas deploy.

  • Branch deployments. canvas deploy --branch deploys a branch other than main to your organization’s test instances, so you can try work that hasn’t merged.