Getting Started
Create a file ~/.canvas/credentials.ini and add the client_id and client_secret credentials for each of your Canvas instances. You can define your default host with is_default=true. If no default is explicitly defined, the Canvas CLI will use the first instance in the file as the default for each of the CLI commands.
Example:
[my-canvas-instance]
client_id=myclientid
client_secret=myclientsecret
[my-dev-canvas-instance]
client_id=devclientid
client_secret=devclientsecret
is_default=true
[localhost]
client_id=localclientid
client_secret=localclientsecret
Next, you're ready to install canvas.
pip install canvas
Usage:
$ canvas [OPTIONS] COMMAND [ARGS]...
Options:
--version--help: Show this message and exit.
Commands:
init: Create a new plugininstall: Install a plugin into a Canvas instanceuninstall: Uninstall a plugin from a Canvas instancedisable: Disable a plugin from a Canvas instanceenable: Enable a plugin from a Canvas instancelist: List all plugins from a Canvas instancevalidate-manifest: Validate the Canvas Manifest json filelogs: Listen and print log streams from a Canvas instance
canvas init
Create a new plugin.
Usage:
$ canvas init [OPTIONS]
Options:
--help: Show this message and exit.
canvas install
Install a plugin into a Canvas instance.
Usage:
$ canvas install [OPTIONS] PLUGIN_NAME
Arguments:
PLUGIN_NAME: Path to plugin to install [required]
Options:
--host TEXT: Canvas instance to connect to--help: Show this message and exit.
canvas uninstall
Uninstall a plugin from a Canvas instance..
Usage:
$ canvas uninstall [OPTIONS] NAME
Arguments:
NAME: Plugin name to delete [required]
Options:
--host TEXT: Canvas instance to connect to--help: Show this message and exit.
canvas enable
Enable a plugin from a Canvas instance..
Usage:
$ canvas enable [OPTIONS] NAME
Arguments:
NAME: Plugin name to enable [required]
Options:
--host TEXT: Canvas instance to connect to--help: Show this message and exit.
canvas disable
Disable a plugin from a Canvas instance..
Usage:
$ canvas disable [OPTIONS] NAME
Arguments:
NAME: Plugin name to disable [required]
Options:
--host TEXT: Canvas instance to connect to--help: Show this message and exit.
canvas list
List all plugins from a Canvas instance.
Usage:
$ canvas list [OPTIONS]
Options:
--host TEXT: Canvas instance to connect to--help: Show this message and exit.
canvas validate-manifest
Validate the Canvas Manifest json file.
Usage:
$ canvas validate-manifest [OPTIONS] PACKAGE
Arguments:
PLUGIN_NAME: Path to plugin to install [required]
Options:
--help: Show this message and exit.
canvas logs
Listens and prints log streams from the instance.
Usage:
$ canvas logs [OPTIONS]
Options:
--host TEXT: Canvas instance to connect to--help: Show this message and exit.
2 maintainers
Release files for canvas 0.216.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| canvas-0.216.1.tar.gz | 2.5 MB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| canvas-0.216.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 5.3 MB
Release files / canvas-0.216.1.tar.gz
| Download URL | canvas-0.216.1.tar.gz |
|---|---|
| Size | 2.5 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
dd10ec9c78c4fa42ecd097076d3a573276b7b32102d149307be97d8c75f7267c
|
|
BLAKE2b-256 checksum How to use checksums |
75d7780bbad5d6438200291b408352689d4ea72b4ea7d7c2429f19655547ecae
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 1, 2026.
Transparency logRelease files / canvas-0.216.1-py3-none-any.whl
| Download URL | canvas-0.216.1-py3-none-any.whl |
|---|---|
| Size | 2.8 MB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
28c3520ceb8651ddbf458e637777097d89a04bf027ac1cf17b4396e38998d404
|
|
BLAKE2b-256 checksum How to use checksums |
22c537cc52c420c085e935d3382cce8f893c447ac5a7f2df1d3c930cc622f2ca
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 1, 2026.
Transparency log
