quilt3 CLI
usage: quilt3 catalog [-h] [--detailed_help] [navigation_target]​Run Quilt catalog locally​positional arguments:navigation_target Which page in the local catalog to open. Leave blank togo to the catalog landing page, pass in an s3 url (e.g.'s3://bucket/myfile.txt') to go to file viewer, or passin a package name in the form 'BUCKET:USER/PKG' to go tothe package viewer.​optional arguments:-h, --help show this help message and exit--detailed_help Display detailed information about this command and thenexit
Run the Quilt catalog on your machine (requires Docker). Running quilt3 catalog launches a webserver on your local machine using Docker and a Python microservice that supplies temporary AWS credentials to the catalog. Temporary credentials are derived from your default AWS credentials (or active AWS_PROFILE) using boto3.sts.get_session_token. For more details about configuring and using AWS credentials in boto3, see the AWS documentation: https://boto3.amazonaws.com/v1/documentation/api/latest/guide/configuration.html​
The Quilt catalog allows users to preview files in S3 without downloading. It relies on a API Gateway and AWS Lambda to generate certain previews in the cloud. The catalog launched by quilt3 catalog sends preview requests to https://open.quiltdata.com. Preview requests contain short-lived signed URLs generated using your AWS credentials. Data is encrypted in transit and no data is retained by Quilt. Nevertheless, it is recommended that you use quilt3 catalog only for public data. We strongly encourage users with sensitive data in S3 to run a private Quilt deployment. Visit https://quiltdata.com for more information.
usage: quilt3 install [-h] [--registry REGISTRY] [--top-hash TOP_HASH][--dest DEST] [--dest-registry DEST_REGISTRY]name​Install a package​positional arguments:name Name of package, in the USER/PKG format​optional arguments:-h, --help show this help message and exit--registry REGISTRY Registry where package is located, usually s3://MY-BUCKET. Defaults to the default remote registry.--top-hash TOP_HASH Hash of package to install. Defaults to latest.--dest DEST Local path to download files to.--dest-registry DEST_REGISTRYRegistry to install package to. Defaults to localregistry.
usage: quilt3 verify [-h] --registry REGISTRY --top-hash TOP_HASH --dir DIR[--extra-files-ok]name​Verify that package contents matches a given directory​positional arguments:name Name of package, in the USER/PKG format​optional arguments:-h, --help show this help message and exit--registry REGISTRY Registry where package is located, usually s3://MY-BUCKET--top-hash TOP_HASH Hash of package to verify--dir DIR Directory to verify--extra-files-ok Directory to verify
usage: quilt3 login [-h]​Log in to configured Quilt server​optional arguments:-h, --help show this help message and exit
usage: quilt3 logout [-h]​Log out of current Quilt server​optional arguments:-h, --help show this help message and exit
usage: quilt3 config [-h] [catalog_url]​Configure Quilt​positional arguments:catalog_url URL of catalog to config with, or empty string to reset theconfig​optional arguments:-h, --help show this help message and exit
usage: quilt3 disable-telemetry [-h]​Disable anonymous usage metrics​optional arguments:-h, --help show this help message and exit
usage: quilt3 list-packages [-h] registry​List all packages in a registry​positional arguments:registry Registry for packages, e.g. s3://quilt-example​optional arguments:-h, --help show this help message and exit
