Skip to content

Commit 3aab97d

Browse files
committed
Document --open-browser; improve CLI help output
1 parent ab88ce5 commit 3aab97d

2 files changed

Lines changed: 10 additions & 2 deletions

File tree

docs/xcetool.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,8 @@ Options:
5757
already.
5858
- `-k`, `--keep`: Keep container after it has finished
5959
running.
60+
- `-b`, `--open-browser`: After the server has started, open a web browser
61+
window showing the viewer. Implies `--server`.
6062
- `--help`: Show a help message for this subcommand and exit.
6163

6264
This subcommand runs an xcengine container image. Any arguments provided

xcengine/cli.py

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,12 @@
2828
help="Create and run compute engine scripts and containers "
2929
"from IPython notebooks"
3030
)
31-
@click.option("-v", "--verbose", count=True)
31+
@click.option(
32+
"-v",
33+
"--verbose",
34+
count=True,
35+
help="Increase the verbosity of the log messages."
36+
)
3237
def cli(verbose):
3338
if verbose > 0:
3439
logging.getLogger().setLevel(logging.DEBUG)
@@ -231,7 +236,8 @@ def increase_indent(self, flow=False, indentless=False):
231236
"-b",
232237
"--open-browser",
233238
is_flag=True,
234-
help="Open a web browser window showing the viewer. Implies --server.",
239+
help="After the server has started, open a web browser window "
240+
"showing the viewer. Implies --server.",
235241
)
236242
@click.argument("image", type=str)
237243
@click.argument(

0 commit comments

Comments
 (0)