|
| 1 | +# JupyterLab Desktop CLI |
| 2 | + |
| 3 | +JupyterLab Desktop comes with a CLI (`jlab`) that provides a rich set of commands and options to launch and configure the application. Below are the CLI options with examples. |
| 4 | + |
| 5 | +## Setting up the `jlab` CLI command |
| 6 | + |
| 7 | +JupyterLab Desktop installers for Windows and Linux create `jlab` CLI command as part of the installation process. However, macOS application creates this command at first launch and after updates. This command creation might sometimes fail if the user doesn't have the required permissions. See this [troubleshooting section](troubleshoot.md#macOS-write-permission-issues) to properly setup CLI on macOS. |
| 8 | + |
| 9 | +## Jupyterlab Desktop CLI commands |
| 10 | + |
| 11 | +- [`jlab` _Application launch_](#jlab-options) |
| 12 | +- [`jlab env` _Python environment management_](#jlab-env-options) |
| 13 | +- [`jlab config` _Application and project setting management_](#jlab-config-options) |
| 14 | +- [`jlab appdata` _Access application cache data_](#jlab-appdata-options) |
| 15 | +- [`jlab logs` _Access application logs_](#jlab-logs-options) |
| 16 | + |
| 17 | +### `jlab <options>` |
| 18 | + |
| 19 | +- Open directories using relative or absolute path |
| 20 | + - `jlab .` launch in current directory |
| 21 | + - `jlab ../notebooks` launch with relative path |
| 22 | + - `jlab /Users/username/notebooks` launch with absolute path |
| 23 | +- Open notebooks and other files using relative or absolute path |
| 24 | + - `jlab /Users/username/notebooks/test.ipynb` launch notebook with absolute path |
| 25 | + - `jlab ../notebooks/test.ipynb` launch notebook with relative path |
| 26 | + - `jlab ../test.py` launch python file with relative path |
| 27 | +- Open with a custom Python environment |
| 28 | + - `jlab --python-path /Users/username/custom_env/bin/python ../notebooks/test.ipynb` launch notebook with custom Python environment |
| 29 | +- Connect to existing JupyterLab server |
| 30 | + - `jlab https://example.org/lab?token=abcde` |
| 31 | + |
| 32 | +### `jlab env <options>` |
| 33 | + |
| 34 | +See Python environment management [documentation](python-env-management.md#python-environment-management-using-cli) for `jlab env` CLI options. |
| 35 | + |
| 36 | +### `jlab config <options>` |
| 37 | + |
| 38 | +- #### `jlab config list [--project-path]` |
| 39 | + |
| 40 | + Show application settings together with any project level overrides. If `--project-path` is set then setting overrides for the project in the specified directory are listed otherwise overrides for the current working directory are listed. |
| 41 | + |
| 42 | + Examples: |
| 43 | + |
| 44 | + ```bash |
| 45 | + # list global application settings and project overrides in current working directory |
| 46 | + jlab config list |
| 47 | + # list global application settings and project overrides in /opt/test-project |
| 48 | + jlab config list --project-path=/opt/test-project |
| 49 | + ``` |
| 50 | + |
| 51 | +- #### `jlab config set <setting-key> <setting-value> [--project] [--project-path]` |
| 52 | + |
| 53 | + Set global application setting or project setting. If called without `--project` and `--project-path` sets global application setting. Calling with `--project` sets the project override for the current working directory. Calling with `--project-path` sets the project override for the specified directory. |
| 54 | + |
| 55 | + Examples: |
| 56 | + |
| 57 | + ```bash |
| 58 | + # set checkForUpdatesAutomatically to false |
| 59 | + jlab config set checkForUpdatesAutomatically false |
| 60 | + # set theme to "dark" |
| 61 | + jlab config set theme "dark" |
| 62 | + # set the global default Python path for JupyterLab server |
| 63 | + jlab config set pythonPath /Users/username/custom_env/bin/python |
| 64 | + # set the default Python path for JupyterLab server for project at current working directory |
| 65 | + jlab config set pythonPath /Users/username/custom_env/bin/python --project |
| 66 | + # set the default Python path for JupyterLab server for particular project |
| 67 | + jlab config set pythonPath /Users/username/custom_env/bin/python --project-path=/opt/test-project |
| 68 | + # set conda channels to ["conda-forge", "bioconda"] on Windows |
| 69 | + jlab config set condaChannels [\"conda-forge\",\"bioconda\"] |
| 70 | + # set conda channels to ["conda-forge", "bioconda"] on macOS and Linux |
| 71 | + config set condaChannels '["conda-forge","bioconda"]' |
| 72 | + ``` |
| 73 | + |
| 74 | +- #### `jlab config unset <setting-key> [--project] [--project-path]` |
| 75 | + |
| 76 | + Unset/reset global application setting or project setting. If called without `--project` and `--project-path` unsets global application setting. Calling with `--project` unsets the project override for the current working directory. Calling with `--project-path` unsets the project override for the specified directory. Once a project setting is unset it defaults to global setting. Once a global setting is unset its default value is used. |
| 77 | + |
| 78 | + Examples: |
| 79 | + |
| 80 | + ```bash |
| 81 | + # unset checkForUpdatesAutomatically |
| 82 | + jlab config unset checkForUpdatesAutomatically |
| 83 | + # unset the global default Python path for JupyterLab server |
| 84 | + jlab config unset pythonPath |
| 85 | + # unset the default Python path for JupyterLab server for project at current working directory |
| 86 | + jlab config unset pythonPath --project |
| 87 | + # unset the default Python path for JupyterLab server for particular project |
| 88 | + jlab config unset pythonPath --project-path=/opt/test-project |
| 89 | + ``` |
| 90 | + |
| 91 | +- #### `jlab config open-file [--project] [--project-path]` |
| 92 | + |
| 93 | + Open the settings JSON file for the global settings or project settings using the default File editor on system. If called without `--project` and `--project-path` opens global application settings file. Calling with `--project` opens the settings file for the the project at current working directory. Calling with `--project-path` opens the settings file for the project at specified directory. |
| 94 | + |
| 95 | + Examples: |
| 96 | + |
| 97 | + ```bash |
| 98 | + # open global settings file |
| 99 | + jlab config open-file |
| 100 | + # open settings file for project at current working directory |
| 101 | + jlab config open-file --project |
| 102 | + # open settings file for particular project |
| 103 | + jlab config open-file --project-path=/opt/test-project |
| 104 | + ``` |
| 105 | + |
| 106 | +### `jlab appdata <options>` |
| 107 | + |
| 108 | +- #### `jlab appdata list` |
| 109 | + |
| 110 | + Show application data. This is the data cached by the app and reused at restart. Some of the data is not listed for simplicity but can be accessed using the `open-file` option. |
| 111 | + |
| 112 | + Examples: |
| 113 | + |
| 114 | + ```bash |
| 115 | + # list application data |
| 116 | + jlab appdata list |
| 117 | + ``` |
| 118 | + |
| 119 | +- #### `jlab appdata open-file` |
| 120 | + |
| 121 | + Open the application data JSON file using the default File editor on system. |
| 122 | + |
| 123 | + Examples: |
| 124 | + |
| 125 | + ```bash |
| 126 | + # open the application data file |
| 127 | + jlab appdata open-file |
| 128 | + ``` |
| 129 | + |
| 130 | +### `jlab logs <options>` |
| 131 | + |
| 132 | +- #### `jlab logs show` |
| 133 | + |
| 134 | + Show application logs in system Terminal. |
| 135 | + |
| 136 | + Examples: |
| 137 | + |
| 138 | + ```bash |
| 139 | + # show application data |
| 140 | + jlab logs show |
| 141 | + ``` |
| 142 | + |
| 143 | +- #### `jlab logs open-file` |
| 144 | + |
| 145 | + Open the application log file using the default File editor on system. |
| 146 | + |
| 147 | + Examples: |
| 148 | + |
| 149 | + ```bash |
| 150 | + # open the application log file |
| 151 | + jlab logs open-file |
| 152 | + ``` |
| 153 | + |
| 154 | +For additional CLI options run `jlab --help` in command line. |
0 commit comments