gamesheet_sdk.admin.cli.commands.leagues module¶
Leagues command group.
This module provides the CLI interface for managing GameSheet leagues, which represent organizational
units within an association. A league typically corresponds to a specific division, age group, or
competition tier within the broader association structure.
The command group provides sub-commands for listing leagues within a specified association. When invoked
without a sub-command, it defaults to the list operation.
.. admonition:: Examples
- List all leagues in an association in simple table format::
$ gamesheet-admin leagues –association-id ABC123
- List leagues in JSON format::
$ gamesheet-admin leagues list –association-id ABC123 –format json
- List leagues with selected columns only::
$ gamesheet-admin leagues list –association-id ABC123 –columns id,name,season_count
- Save leagues to a file::
$ gamesheet-admin leagues list –association-id ABC123 –format yaml –output leagues.yaml
- Use environment variable for association ID::
$ export GAMESHEET_ASSOCIATION_ID=ABC123 $ gamesheet-admin leagues