Improve CLI deploy help message (#3035)

Co-authored-by: José Valim <jose.valim@dashbit.co>
This commit is contained in:
Hugo Baraúna 2025-07-30 10:43:54 -03:00 committed by GitHub
parent 4997e07e8d
commit e6d615432d
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -10,12 +10,12 @@ defmodule LivebookCLI.Deploy do
@impl true @impl true
def usage() do def usage() do
""" """
Usage: livebook deploy [options] filename|directory Usage: livebook deploy [options] filename [filename...]
## Available options ## Available options
--deploy-key Sets the deploy key to authenticate with Livebook Teams --deploy-key Deploy key from your Livebook Teams organization
--teams-key Sets the Teams key to authenticate with Livebook Teams and encrypt the Livebook app --teams-key Teams key from your Teams workspace
--deployment-group The deployment group name which you want to deploy to --deployment-group The deployment group name which you want to deploy to
The --help option can be given to print this notice. The --help option can be given to print this notice.
@ -24,11 +24,11 @@ defmodule LivebookCLI.Deploy do
Deploys a single notebook: Deploys a single notebook:
livebook deploy --deploy-key="lb_dk_..." --teams-key="lb_tk_..." --deployment-group "online" path/to/app1.livemd livebook deploy --deploy-key="lb_dk_..." --teams-key="lb_tk_..." --deployment-group="production" path/to/app1.livemd
Deploys multiple notebooks: Deploys multiple notebooks:
livebook deploy --deploy-key="lb_dk_..." --teams-key="lb_tk_..." --deployment-group "online" path/to/*.livemd\ livebook deploy --deploy-key="lb_dk_..." --teams-key="lb_tk_..." --deployment-group="production" path/to/*.livemd\
""" """
end end