MultiTool CLI commands
This document contains the help content for the MultiTool CLI.
Command overview
multitool
Usage: multitool [OPTIONS] [COMMAND]
Subcommands
login
— Log in to the hosted SaaSlogout
—run
— Run will executemulti
in "runner mode", where it will immediately deploy the provided artifact and start canaryingversion
— Print the CLI version and exit
Options
-
--enable-colors <ENABLE_COLORS>
— Whether to color the outputDefault value:
auto
Possible values:
always
: Always color the outputnever
: Never color the outputauto
: Detect whether the terminal is a tty before deciding to color
-
--log-level <LOG_LEVEL>
— Sets the maximum log level. Defaults to INFO. Options are 'trace', 'debug', 'info', 'warn', 'error', and 'off'. 'off' implies no logger will occur. Options are case-insensitiveDefault value:
info
multitool login
Log in to the hosted SaaS
Usage: multitool login [OPTIONS]
Options
-
--email <EMAIL>
— The email of the account -
--password <PASSWORD>
— The password of the account -
-o
,--origin <ORIGIN>
Default value:
https://api.multitool.run
multitool logout
Usage: multitool logout
multitool run
Run will execute multi
in "runner mode", where it will immediately deploy the provided artifact and start canarying
Usage: multitool run [OPTIONS] [ARTIFACT_PATH]
Arguments
<ARTIFACT_PATH>
— The path to the function to upload
Options
-
-w
,--workspace <WORKSPACE>
-
-a
,--application <APPLICATION>
-
-o
,--origin <ORIGIN>
Default value:
https://api.multitool.run
-
--cloudflare-account-id <CLOUDFLARE_ACCOUNT_ID>
— Cloudflare config The Cloudflare account ID to use when deploying to Workers -
--cloudflare-worker-name <CLOUDFLARE_WORKER_NAME>
— The name of the Cloudflare Worker to deploy -
--cloudflare-api-token <CLOUDFLARE_API_TOKEN>
— The name of the Cloudflare Worker to deploy -
--cloudflare-main-module <CLOUDFLARE_MAIN_MODULE>
— The name of the main module for the Cloudflare Worker -
--aws-region <AWS_REGION>
— AWS Config The AWS region to deploy into -
--aws-gateway-name <AWS_GATEWAY_NAME>
— The AWS API Gateway's Name -
--aws-stage-name <AWS_STAGE_NAME>
— The AWS API Gateway Stage's Name -
--aws-resource-path <AWS_RESOURCE_PATH>
— The AWS API Gateway Stage's Path (with leading slash) -
--aws-resource-method <AWS_RESOURCE_METHOD>
— The AWS API Gateway Stage's HTTP Method -
--aws-lambda-name <AWS_LAMBDA_NAME>
— The AWS Lambda's Name
multitool version
Print the CLI version and exit
Usage: multitool version
This document was generated automatically by clap-markdown .