ClearML/clearml-session
1
0
Fork 0
mirror of https://github.com/clearml/clearml-session synced 2025-02-11 23:23:12 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Add new flags to README

Browse Source
This commit is contained in:
allegroai 2023-07-20 12:06:50 +03:00
parent 62e471b130
commit ece8dd1421
1 changed files with 12 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
README.md
View File

@ -170,9 +170,7 @@ It will shut down the remote session, free the resource and close the CLI
``` console ``` console
Enter "r" (or "reconnect") to reconnect the session (for example after suspend) Enter "r" (or "reconnect") to reconnect the session (for example after suspend)
Ctrl-C (or "quit") to abort (remote session rema Ctrl-C (or "quit") to abort (remote session remains active)
Yes of course, current SSO supports Google/GitHub/BitBucket/... + SAML/LDAP (Usually with user permissions fully integrated to the LDAP)
ins active)
or "Shutdown" to shutdown remote interactive session or "Shutdown" to shutdown remote interactive session
shutdown shutdown
@ -226,6 +224,7 @@ usage: clearml-session [-h] [--version] [--attach [ATTACH]]
[--remote-ssh-port REMOTE_SSH_PORT] [--remote-ssh-port REMOTE_SSH_PORT]
[--vscode-server [true/false]] [--vscode-server [true/false]]
[--vscode-version VSCODE_VERSION] [--vscode-version VSCODE_VERSION]
[--vscode-extensions VSCODE_EXTENSIONS]
[--jupyter-lab [true/false]] [--jupyter-lab [true/false]]
[--git-credentials [true/false]] [--git-credentials [true/false]]
[--user-folder USER_FOLDER] [--user-folder USER_FOLDER]
@ -239,7 +238,8 @@ usage: clearml-session [-h] [--version] [--attach [ATTACH]]
[--queue-excluded-tag [QUEUE_EXCLUDED_TAG [QUEUE_EXCLUDED_TAG ...]]] [--queue-excluded-tag [QUEUE_EXCLUDED_TAG [QUEUE_EXCLUDED_TAG ...]]]
[--queue-include-tag [QUEUE_INCLUDE_TAG [QUEUE_INCLUDE_TAG ...]]] [--queue-include-tag [QUEUE_INCLUDE_TAG [QUEUE_INCLUDE_TAG ...]]]
[--skip-docker-network] [--password PASSWORD] [--skip-docker-network] [--password PASSWORD]
[--username USERNAME] [--verbose] [--yes] [--username USERNAME] [--force_dropbear [true/false]]
[--verbose] [--yes]
clearml-session - CLI for launching JupyterLab / VSCode on a remote machine clearml-session - CLI for launching JupyterLab / VSCode on a remote machine
@ -279,6 +279,11 @@ optional arguments:
Set vscode server (code-server) version, as well as Set vscode server (code-server) version, as well as
vscode python extension version <vscode:python-ext> vscode python extension version <vscode:python-ext>
(example: "3.7.4:2020.10.332292344") (example: "3.7.4:2020.10.332292344")
--vscode-extensions VSCODE_EXTENSIONS
Install additional vscode extensions, as well as
vscode python extension (example: "ms-
python.python,ms-python.black-formatter,ms-
python.pylint,ms-python.flake8")
--jupyter-lab [true/false] --jupyter-lab [true/false]
Install Jupyter-Lab on interactive session (default: Install Jupyter-Lab on interactive session (default:
true) true)
@ -333,10 +338,12 @@ optional arguments:
used one) used one)
--username USERNAME Advanced: Select ssh username for the interactive --username USERNAME Advanced: Select ssh username for the interactive
session (default: `root` or previously used one) session (default: `root` or previously used one)
--force_dropbear [true/false]
Force using `dropbear` instead of SSHd
--verbose Advanced: If set, print verbose progress information, --verbose Advanced: If set, print verbose progress information,
e.g. the remote machine setup process log e.g. the remote machine setup process log
--yes, -y Automatic yes to prompts; assume "yes" as answer to --yes, -y Automatic yes to prompts; assume "yes" as answer to
all prompts and run non-interactively all prompts and run non-interactively
Notice! all arguments are stored as new defaults for the next session Notice! all arguments are stored as new defaults for the next session
``` ```