Command Line Interface¶
etb¶
eToolBox CLI.
etb [OPTIONS] COMMAND [ARGS]...
Options
- --version¶
Show the version and exit.
cloud¶
RMI cloud utilities.
etb cloud [OPTIONS] COMMAND [ARGS]...
cache¶
Return info about cloud cache contents.
etb cloud cache [OPTIONS]
clean¶
Delete local cache of Azure files in .cache/rmi.cloud.
etb cloud clean [OPTIONS]
Options
- -d, --dry-run¶
- -a, --all¶
Delete config as well as file cache.
- Default:
False
get¶
Download a remote file from the cloud.
etb cloud get [OPTIONS] SOURCE [DESTINATION]
Options
- -c, --clobber¶
Overwrite existing files
- Default:
False
Arguments
- SOURCE¶
Required argument
- DESTINATION¶
Optional argument
init¶
Store SAS token and account name for reading from and writing to Azure.
etb cloud init [OPTIONS] [ACCOUNT_NAME] [TOKEN]
Options
- -d, --dry-run¶
- Default:
False
- -c, --clobber¶
Overwrite existing files.
- Default:
False
Arguments
- ACCOUNT_NAME¶
Optional argument
- TOKEN¶
Optional argument
list¶
List all files in Azure container.
etb cloud list [OPTIONS] DIRECTORY
Options
- -l, --detail¶
Show file details.
- Default:
False
Arguments
- DIRECTORY¶
Required argument
put¶
Upload local files or directories to the cloud.
etb cloud put [OPTIONS] SOURCE DESTINATION
Options
- -c, --clobber¶
Overwrite existing files
- Default:
False
Arguments
- SOURCE¶
Required argument
- DESTINATION¶
Required argument
pudl¶
PUDL utilities.
etb pudl [OPTIONS] COMMAND [ARGS]...
cache¶
List files stored in rmi.pudl local cache at .cache/rmi.pudl/aws.
etb pudl cache [OPTIONS]
clean¶
Remove rmi.pudl local cache at .cache/rmi.pudl/aws.
etb pudl clean [OPTIONS]
Options
- -l, --legacy¶
- Default:
False
- -a, --all¶
- Default:
False
- -d, --dry-run¶
- Default:
False
get¶
Download PUDL table from AWS as a csv.
etb pudl get [OPTIONS] TABLE RELEASE [DESTINATION]
Arguments
- TABLE¶
Required argument
- RELEASE¶
Required argument
- DESTINATION¶
Optional argument
list¶
List files in PUDL release or list releases.
etb pudl list [OPTIONS] [RELEASE]
Options
- -l, --detail¶
If True, return details of each table, otherwise just names.
- Default:
False
Arguments
- RELEASE¶
Optional argument
rename¶
Rename PUDL tables in files that match a provided pattern.
etb pudl rename [OPTIONS] PATTERN
Options
- -d, --dry-run¶
- Default:
False
- -y, --yes¶
Sets any confirmation values to ‘yes’ automatically. users will not be asked to confirm before tables are renamed.
- Default:
False
Arguments
- PATTERN¶
Required argument