Skip to content

Commit 81824f8

Browse files
committed
add help for CLI options
1 parent 333d15d commit 81824f8

File tree

1 file changed

+18
-3
lines changed

1 file changed

+18
-3
lines changed

rsconnect/main.py

Lines changed: 18 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1408,9 +1408,24 @@ def deploy_help():
14081408
)
14091409
@server_args
14101410
@click.option("--app_name", "-a")
1411-
@click.option("--repository", "-r", required=True)
1412-
@click.option("--branch", "-b", default="main")
1413-
@click.option("--subdirectory", "-d", default="/")
1411+
@click.option(
1412+
"--repository",
1413+
"-r",
1414+
required=True,
1415+
help="Repository URL to deploy, e.g. https://github.com/username/repository. Only https URLs are supported.",
1416+
)
1417+
@click.option(
1418+
"--branch",
1419+
"-b",
1420+
default="main",
1421+
help="Name of the branch to deploy. Connect will automatically deploy updates when commits are pushed to the branch.",
1422+
)
1423+
@click.option(
1424+
"--subdirectory",
1425+
"-d",
1426+
default="/",
1427+
help="Directory within the repository to deploy. The directory must contain a manifest.json file.",
1428+
)
14141429
@click.option("--title", "-t", help="Title of the content (default is the same as the filename).")
14151430
@click.option(
14161431
"--environment",

0 commit comments

Comments
 (0)