canvas config
canvas config¶
Manage Canvas CLI configuration
Synopsis¶
Manage Canvas CLI configuration including Canvas instances and settings.
Examples:
canvas config list # List all configured instances
canvas config add prod --url https://canvas.example.com
canvas config use prod # Switch to prod instance
canvas config show # Show current configuration
canvas config remove staging # Remove an instance
Options¶
Options inherited from parent commands¶
--as-user int Masquerade as another user (admin feature, requires permission)
--columns strings Select specific columns to display (comma-separated)
--config string config file (default is $HOME/.canvas-cli/config.yaml)
--dry-run Print curl commands instead of executing requests
--filter string Filter results by text (case-insensitive substring match)
--instance string Canvas instance URL (overrides config)
--limit int Limit number of results for list operations (0 = unlimited)
--no-cache Disable caching of API responses
-o, --output string Output format: table, json, yaml, csv (default "table")
--show-token Show actual token in dry-run output (default: redacted)
--sort string Sort results by field (prefix with - for descending, e.g., -name)
-v, --verbose Enable verbose output
SEE ALSO¶
- canvas - Canvas LMS CLI - Interact with Canvas from the command line
- canvas config account - Set the default account ID for an instance
- canvas config add - Add a new Canvas instance
- canvas config list - List all configured Canvas instances
- canvas config remove - Remove a Canvas instance from configuration
- canvas config show - Show current configuration details
- canvas config use - Switch to a different Canvas instance