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
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file canvas-0.198.2.tar.gz.
File metadata
- Download URL: canvas-0.198.2.tar.gz
- Upload date:
- Size: 2.4 MB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
90f40ac2d6b0463f04735087c95ce5d8b8463703c6b9267a3d723efb23feb697
|
|
| MD5 |
677866f3f53981d265aee82040a285f4
|
|
| BLAKE2b-256 |
aaba107c2fce04cf41ad6961c6dac0aebd167e0c58951c96fc9c76c1096fb71f
|
Provenance
The following attestation bundles were made for canvas-0.198.2.tar.gz:
Publisher:
publish-and-release.yml on canvas-medical/canvas-plugins
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
canvas-0.198.2.tar.gz -
Subject digest:
90f40ac2d6b0463f04735087c95ce5d8b8463703c6b9267a3d723efb23feb697 - Sigstore transparency entry: 2501382154
- Sigstore integration time:
-
Permalink:
canvas-medical/canvas-plugins@f8fae018036c2f0a3129305378a567b6c6ad94cc -
Branch / Tag:
refs/heads/main - Owner: https://github.com/canvas-medical
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish-and-release.yml@f8fae018036c2f0a3129305378a567b6c6ad94cc -
Trigger Event:
workflow_dispatch
-
Statement type:
File details
Details for the file canvas-0.198.2-py3-none-any.whl.
File metadata
- Download URL: canvas-0.198.2-py3-none-any.whl
- Upload date:
- Size: 2.8 MB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
a6627eee0530e2204e5d6816fe254f5c9eaab056d6cb3dd17aab888a41d37f62
|
|
| MD5 |
e580ca1a1ad557ef93e3a4872d2d3ab2
|
|
| BLAKE2b-256 |
a9dd427ab722264d4e44b126fb41322ffaf37753d98046db9288f93d2d526088
|
Provenance
The following attestation bundles were made for canvas-0.198.2-py3-none-any.whl:
Publisher:
publish-and-release.yml on canvas-medical/canvas-plugins
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
canvas-0.198.2-py3-none-any.whl -
Subject digest:
a6627eee0530e2204e5d6816fe254f5c9eaab056d6cb3dd17aab888a41d37f62 - Sigstore transparency entry: 2501382167
- Sigstore integration time:
-
Permalink:
canvas-medical/canvas-plugins@f8fae018036c2f0a3129305378a567b6c6ad94cc -
Branch / Tag:
refs/heads/main - Owner: https://github.com/canvas-medical
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish-and-release.yml@f8fae018036c2f0a3129305378a567b6c6ad94cc -
Trigger Event:
workflow_dispatch
-
Statement type:
