mycli 2.2.0__tar.gz → 2.4.0__tar.gz

{mycli-2.2.0 → mycli-2.4.0}/AGENTS.md

@@ -31,7 +31,7 @@ A command line client for MySQL with auto-completion and syntax highlighting.
 ├── mycli/main_modes/checkup.py           # `--checkup` mode
 ├── mycli/main_modes/execute.py           # `--execute` mode
 ├── mycli/main_modes/list_dsn.py          # `--list-dsn` mode
-├── mycli/main_modes/repl.py              # interactive REPL made
+├── mycli/main_modes/repl.py              # interactive REPL mode
 ├── mycli/myclirc                         # project-level configuration file
 ├── mycli/output.py                       # `OutputMixin` mixin for feedback and output of query results
 ├── mycli/packages/                       # application packages
@@ -48,16 +48,18 @@ A command line client for MySQL with auto-completion and syntax highlighting.
 ├── mycli/packages/sqlresult.py           # the `SQLResult` dataclass for holding responses
 ├── mycli/packages/string_utils.py        # generic string utilities
 ├── mycli/packages/tabular_output/        # extends cli_helper with additional output formats
+├── mycli/password_sources.py             # password sources and precedence
+├── mycli/ssh_tunnel.py                   # connecting over a tunnel with `--ssh-jump`
 ├── mycli/schema_prefetcher.py            # background prefetcher for multi-schema auto-completion
 ├── mycli/sqlcompleter.py                 # offers SQL completions
 ├── mycli/sqlexecute.py                   # runs SQL queries
 ├── mycli/types.py                        # shared types
 ├── mycli/vault.py                        # Vault integration
-├── test/conftest.py                      # pytest configuration
 ├── test/features/                        # behave tests
 ├── test/myclirc                          # mycli configuration used for tests
 ├── test/mylogin.cnf                      # `mylogin.cnf` example used for tests
 ├── test/pytests/                         # pytest tests
+├── test/pytests/conftest.py              # pytest configuration
 └── test/utils.py                         # shared utilities for tests
 
 ## Development

{mycli-2.2.0/mycli.egg-info → mycli-2.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mycli
-Version: 2.2.0
+Version: 2.4.0
 Summary: CLI for MySQL Database. With auto-completion and syntax highlighting.
 Author: Mycli Core Team
 License-Expression: BSD-3-Clause
@@ -89,13 +89,13 @@ You might need `sudo` on Linux.
 pip install --upgrade 'mycli[all]'
 ```
 
-or, only on macOS (`fzf` and `pygments` are optional):
+or, only on macOS (`fzf` and `pygments` are optional but recommended):
 
 ```bash
 brew update && brew install mycli fzf pygments
 ```
 
-or, only on Debian or Ubuntu (`fzf` and `pygments` are optional):
+or, only on Debian or Ubuntu (`fzf` and `pygments` are optional but recommended):
 
 ```bash
 sudo apt-get install mycli fzf python3-pygments
@@ -115,6 +115,7 @@ Features
 * Auto-completion as you type for SQL keywords as well as tables, views,
   columns, enums, and more!
 * Fuzzy history search using [fzf](https://github.com/junegunn/fzf).
+* Output explorer using [fzf](https://github.com/junegunn/fzf) or other tools.
 * Syntax highlighting using [Pygments](https://pygments.org/).
 * Smart-completion (enabled by default) will suggest context-sensitive completion.
     - `SELECT * FROM <tab>` will only show table names.
@@ -158,15 +159,15 @@ These are some alternative ways to install mycli that are not managed by our
 team but provided by OS package maintainers.  OS packages could be somewhat
 out of date.
 
-If present, the `fzf` package can be used for fuzzy history search, and
-`pygemtize` can be used for syntax highlighting within the fuzzy history
-search.  The `less` package is also expected, but almost always already
-installed.
+If present, the `fzf` package can be used for fuzzy history search, and as an
+output "explorer" with the `\x` special command. `pygemtize` can be used for
+syntax highlighting within the fuzzy history search.  The `less` package is
+also expected, but almost always already installed.
 
 ### Arch, Manjaro
 
 You can install the `mycli` package available in the AUR.  `fzf` and
-`python-pygments` are optional:
+`python-pygments` are optional but recommended:
 
 ```bash
 yay -S mycli fzf python-pygments
@@ -175,7 +176,8 @@ yay -S mycli fzf python-pygments
 ### Debian, Ubuntu
 
 On Debian and Ubuntu distributions, you can easily install the mycli package
-using apt.  The `fzf` and `python3-pygments` packages are optional:
+using apt.  The `fzf` and `python3-pygments` packages are optional but
+recommended:
 
 ```bash
 sudo apt-get install mycli fzf python3-pygments
@@ -184,7 +186,7 @@ sudo apt-get install mycli fzf python3-pygments
 ### Fedora
 
 Fedora has a package available for mycli; install it using dnf.  The `fzf` and
-`python-pygments` packages are optional:
+`python-pygments` packages are optional but recommended:
 
 ```bash
 sudo dnf install mycli fzf python-pygments
@@ -196,7 +198,9 @@ sudo dnf install mycli fzf python-pygments
 
 Install the `less` pager, for example by `scoop install less`.
 
-Follow the instructions on this blogpost: https://web.archive.org/web/20221006045208/https://www.codewall.co.uk/installing-using-mycli-on-windows/
+Install the `fzf` fuzzy finder, for example by `scoop install fzf`.
+
+Follow the instructions on this blog post: https://web.archive.org/web/20221006045208/https://www.codewall.co.uk/installing-using-mycli-on-windows/
 
 The libraries used in mycli are Windows-compatible, but there are known
 limitations according to the test suite.  The basics work without any
@@ -209,11 +213,24 @@ PRs to address shortcomings on Windows would be welcome!
 Mycli is more compatible with WSL than with native Windows, though still
 not 100% perfect.  This is a good option for using mycli on Windows.
 
+With WSL, you are probably using an Ubuntu distribution, in which case
+recommended dependencies can be installed by
+
+```bash
+sudo apt-get install fzf python3-pygments
+```
+
+and mycli can be installed by `apt-get` or by `pip` (recommended):
+
+```bash
+pip install --upgrade 'mycli[all]'
+```
+
 PRs to complete WSL support would be welcome!
 
 ### Thanks
 
-This project was funded through kickstarter. Our thanks to the [backers](https://mycli.net/sponsors) who supported the project.
+This project was funded through Kickstarter. Our thanks to the [backers](https://mycli.net/sponsors) who supported the project.
 
 A special thanks to [Jonathan Slenders](https://twitter.com/jonathan_s) for
 creating [Python Prompt Toolkit](https://github.com/jonathanslenders/python-prompt-toolkit),
@@ -241,7 +258,7 @@ following in `~/.myclirc`:
 default_character_set = utf8
 ```
 
-or set `--charset=utf8` when invoking MyCLI.
+or set `--charset=utf8` when invoking mycli
 
 ### Configuration and Usage
 

{mycli-2.2.0 → mycli-2.4.0}/README.md

@@ -32,13 +32,13 @@ You might need `sudo` on Linux.
 pip install --upgrade 'mycli[all]'
 ```
 
-or, only on macOS (`fzf` and `pygments` are optional):
+or, only on macOS (`fzf` and `pygments` are optional but recommended):
 
 ```bash
 brew update && brew install mycli fzf pygments
 ```
 
-or, only on Debian or Ubuntu (`fzf` and `pygments` are optional):
+or, only on Debian or Ubuntu (`fzf` and `pygments` are optional but recommended):
 
 ```bash
 sudo apt-get install mycli fzf python3-pygments
@@ -58,6 +58,7 @@ Features
 * Auto-completion as you type for SQL keywords as well as tables, views,
   columns, enums, and more!
 * Fuzzy history search using [fzf](https://github.com/junegunn/fzf).
+* Output explorer using [fzf](https://github.com/junegunn/fzf) or other tools.
 * Syntax highlighting using [Pygments](https://pygments.org/).
 * Smart-completion (enabled by default) will suggest context-sensitive completion.
     - `SELECT * FROM <tab>` will only show table names.
@@ -101,15 +102,15 @@ These are some alternative ways to install mycli that are not managed by our
 team but provided by OS package maintainers.  OS packages could be somewhat
 out of date.
 
-If present, the `fzf` package can be used for fuzzy history search, and
-`pygemtize` can be used for syntax highlighting within the fuzzy history
-search.  The `less` package is also expected, but almost always already
-installed.
+If present, the `fzf` package can be used for fuzzy history search, and as an
+output "explorer" with the `\x` special command. `pygemtize` can be used for
+syntax highlighting within the fuzzy history search.  The `less` package is
+also expected, but almost always already installed.
 
 ### Arch, Manjaro
 
 You can install the `mycli` package available in the AUR.  `fzf` and
-`python-pygments` are optional:
+`python-pygments` are optional but recommended:
 
 ```bash
 yay -S mycli fzf python-pygments
@@ -118,7 +119,8 @@ yay -S mycli fzf python-pygments
 ### Debian, Ubuntu
 
 On Debian and Ubuntu distributions, you can easily install the mycli package
-using apt.  The `fzf` and `python3-pygments` packages are optional:
+using apt.  The `fzf` and `python3-pygments` packages are optional but
+recommended:
 
 ```bash
 sudo apt-get install mycli fzf python3-pygments
@@ -127,7 +129,7 @@ sudo apt-get install mycli fzf python3-pygments
 ### Fedora
 
 Fedora has a package available for mycli; install it using dnf.  The `fzf` and
-`python-pygments` packages are optional:
+`python-pygments` packages are optional but recommended:
 
 ```bash
 sudo dnf install mycli fzf python-pygments
@@ -139,7 +141,9 @@ sudo dnf install mycli fzf python-pygments
 
 Install the `less` pager, for example by `scoop install less`.
 
-Follow the instructions on this blogpost: https://web.archive.org/web/20221006045208/https://www.codewall.co.uk/installing-using-mycli-on-windows/
+Install the `fzf` fuzzy finder, for example by `scoop install fzf`.
+
+Follow the instructions on this blog post: https://web.archive.org/web/20221006045208/https://www.codewall.co.uk/installing-using-mycli-on-windows/
 
 The libraries used in mycli are Windows-compatible, but there are known
 limitations according to the test suite.  The basics work without any
@@ -152,11 +156,24 @@ PRs to address shortcomings on Windows would be welcome!
 Mycli is more compatible with WSL than with native Windows, though still
 not 100% perfect.  This is a good option for using mycli on Windows.
 
+With WSL, you are probably using an Ubuntu distribution, in which case
+recommended dependencies can be installed by
+
+```bash
+sudo apt-get install fzf python3-pygments
+```
+
+and mycli can be installed by `apt-get` or by `pip` (recommended):
+
+```bash
+pip install --upgrade 'mycli[all]'
+```
+
 PRs to complete WSL support would be welcome!
 
 ### Thanks
 
-This project was funded through kickstarter. Our thanks to the [backers](https://mycli.net/sponsors) who supported the project.
+This project was funded through Kickstarter. Our thanks to the [backers](https://mycli.net/sponsors) who supported the project.
 
 A special thanks to [Jonathan Slenders](https://twitter.com/jonathan_s) for
 creating [Python Prompt Toolkit](https://github.com/jonathanslenders/python-prompt-toolkit),
@@ -184,7 +201,7 @@ following in `~/.myclirc`:
 default_character_set = utf8
 ```
 
-or set `--charset=utf8` when invoking MyCLI.
+or set `--charset=utf8` when invoking mycli
 
 ### Configuration and Usage
 

{mycli-2.2.0 → mycli-2.4.0}/changelog.md

@@ -1,3 +1,41 @@
+2.4.0 (2026/07/18)
+==============
+
+Features
+---------
+* Make password sources and precedence configurable.
+* Ability to deselect fallback interactive password prompt.
+* Add `\e` prompt/toolbar format string for edit mode.
+
+
+Bug Fixes
+---------
+* Don't create `~/.myclirc` if the user adopted the XDG layout for myclirc.
+
+
+Internal
+---------
+* Make flaky `/watch` test even more lenient for CI.
+* Add missing file to `AGENTS.md` project layout.
+
+
+2.3.0 (2026/07/16)
+==============
+
+Features
+---------
+* Set minimum times for transient toolbar messages.
+* `editor_command` entry in `~/.myclirc` which overrides environment.
+* Experimental: let Vault properties be set in DSNs.
+* Add a `\x` special command to send output to an explorer rather than a pager.
+
+
+Documentation
+---------
+* Spellcheck myclirc commentary.
+* Better ordering for `/help` table.
+
+
 2.2.0 (2026/07/11)
 ==============
 

{mycli-2.2.0 → mycli-2.4.0}/mycli/TIPS

@@ -138,7 +138,9 @@ set environment variable MYSQL_DSN to set a default DSN!
 ### general
 ###
 
-display query output vertically using \G at the end of a query!
+display output vertically using \G at the end of a query!
+
+display output in an interactive explorer \x at the end of a query!
 
 run SQL scripts in batch mode using the standard input!
 
@@ -282,6 +284,12 @@ use "min_completion_trigger" in ~/.myclirc to defer completions!
 
 colorize search previews with "highlight_preview" in ~/.myclirc!
 
+set editor_command = "code --wait" in ~/.myclirc to edit queries using VS Code!
+
+set up an interactive output explorer using the "[explorer]" section of ~/.myclirc!
+
+customize password sources/precedence with "password_sources" in ~/.myclirc!
+
 ###
 ### redirection
 ###

{mycli-2.2.0 → mycli-2.4.0}/mycli/cli_runner.py

@@ -15,6 +15,7 @@ from mycli.main_modes.checkup import main_checkup
 from mycli.main_modes.execute import main_execute_from_cli
 from mycli.main_modes.list_dsn import main_list_dsn
 from mycli.packages.cli_utils import is_valid_connection_scheme
+from mycli.password_sources import PasswordCandidates
 from mycli.vault import (
     DEFAULT_VAULT_EXECUTABLE,
     DEFAULT_VAULT_PASSWORD_FIELD,
@@ -41,6 +42,11 @@ KNOWN_DSN_QUERY_PARAMS = {
     'ssl_mode',
     'ssl_verify_server_cert',
     'tls_version',
+    'vault_address',
+    'vault_mount',
+    'vault_secret',
+    'vault_password_field',
+    'vault_username_field',
 }
 
 
@@ -160,10 +166,15 @@ def run_from_cli_args(cli_args: 'CliArgs', client_factory: ClientFactory) -> Non
     database = cli_args.dbname or cli_args.database
 
     dsn_uri = None
+    dsn_password: str | None = None
 
     # Treat the database argument as a DSN alias only if it matches a configured alias
     # todo why is port tested but not socket?
-    truthy_password = cli_args.password not in (None, EMPTY_PASSWORD_FLAG_SENTINEL)
+    truthy_password = (
+        cli_args.password not in (None, EMPTY_PASSWORD_FLAG_SENTINEL)
+        or cli_args.password_file is not None
+        or os.environ.get('MYSQL_PWD') is not None
+    )
     if (
         database
         and "://" not in database
@@ -230,9 +241,6 @@ def run_from_cli_args(cli_args: 'CliArgs', client_factory: ClientFactory) -> Non
             database = dsn_database
         if not cli_args.user and dsn_user is not None:
             cli_args.user = dsn_user
-        # todo: rationalize the behavior of empty-string passwords here
-        if not cli_args.password and dsn_password is not None:
-            cli_args.password = dsn_password
         if not cli_args.host:
             cli_args.host = dsn_host
         if not cli_args.port:
@@ -277,6 +285,16 @@ def run_from_cli_args(cli_args: 'CliArgs', client_factory: ClientFactory) -> Non
             cli_args.character_set = cli_args.character_set or params[0]
         if params := dsn_params.get('ssh_jump'):
             cli_args.ssh_jump = cli_args.ssh_jump or params[0]
+        if params := dsn_params.get('vault_address'):
+            cli_args.vault_address = cli_args.vault_address or params[0]
+        if params := dsn_params.get('vault_mount'):
+            cli_args.vault_mount = cli_args.vault_mount or params[0]
+        if params := dsn_params.get('vault_secret'):
+            cli_args.vault_secret = cli_args.vault_secret or params[0]
+        if params := dsn_params.get('vault_password_field'):
+            cli_args.vault_password_field = cli_args.vault_password_field or params[0]
+        if params := dsn_params.get('vault_username_field'):
+            cli_args.vault_username_field = cli_args.vault_username_field or params[0]
 
     keepalive_ticks = cli_args.keepalive_ticks if cli_args.keepalive_ticks is not None else mycli.default_keepalive_ticks
     ssl_mode = cli_args.ssl_mode or mycli.ssl_mode
@@ -349,25 +367,40 @@ def run_from_cli_args(cli_args: 'CliArgs', client_factory: ClientFactory) -> Non
         use_keyring = str_to_bool(cli_args.use_keyring)
         reset_keyring = False
 
-    if cli_args.password is None and cli_args.vault_secret:
+    password_candidates = PasswordCandidates()
+    if cli_args.password == EMPTY_PASSWORD_FLAG_SENTINEL:
+        password_candidates.add_value('prompt', cli_args.password)
+    elif cli_args.password is not None:
+        password_candidates.add_value('literal', cli_args.password)
+    if cli_args.password_file:
+        password_candidates.add_loader('file', lambda: main_module.get_password_from_file(cli_args.password_file))
+    if os.environ.get('MYSQL_PWD') is not None:
+        password_candidates.add_value('environment', os.environ.get('MYSQL_PWD'))
+    if dsn_password is not None:
+        password_candidates.add_value('dsn', dsn_password)
+
+    if cli_args.vault_secret:
+        vault_secret = cli_args.vault_secret
         vault_config = mycli.config.get('vault_beta', {})
         vault_address = cli_args.vault_address or os.environ.get('VAULT_ADDR') or vault_config.get('address') or None
         vault_mount = cli_args.vault_mount or vault_config.get('default_mount') or None
         vault_field = cli_args.vault_password_field or vault_config.get('default_password_field') or DEFAULT_VAULT_PASSWORD_FIELD
         vault_executable = vault_config.get('vault_executable') or DEFAULT_VAULT_EXECUTABLE
-        try:
-            vault_password: str | None = get_field_from_vault(
-                vault_field,
-                cli_args.vault_secret,
-                executable=vault_executable,
-                mount=vault_mount,
-                address=vault_address,
-            )
-        except VaultError as exc:
-            click.secho(f'Error reading password from Vault: {exc}', err=True, fg='red')
-            sys.exit(1)
-    else:
-        vault_password = None
+
+        def load_vault_password() -> str | None:
+            try:
+                return get_field_from_vault(
+                    vault_field,
+                    vault_secret,
+                    executable=vault_executable,
+                    mount=vault_mount,
+                    address=vault_address,
+                )
+            except VaultError as exc:
+                click.secho(f'Error reading password from Vault: {exc}', err=True, fg='red')
+                sys.exit(1)
+
+        password_candidates.add_loader('vault', load_vault_password)
 
     if cli_args.user is None and cli_args.vault_secret:
         vault_config = mycli.config.get('vault_beta', {})
@@ -388,12 +421,13 @@ def run_from_cli_args(cli_args: 'CliArgs', client_factory: ClientFactory) -> Non
             sys.exit(1)
     else:
         vault_username = None
+    vault_username_from_vault = vault_username is not None
 
     try:
         mycli.connect(
             database=database,
             user=vault_username if cli_args.user is None else cli_args.user,
-            passwd=vault_password if cli_args.password is None else cli_args.password,
+            password_candidates=password_candidates,
             host=cli_args.host,
             port=cli_args.port,
             socket=cli_args.socket,
@@ -407,6 +441,12 @@ def run_from_cli_args(cli_args: 'CliArgs', client_factory: ClientFactory) -> Non
             keepalive_ticks=keepalive_ticks,
             ssh_jump=cli_args.ssh_jump,
             ssh_cli_options=cli_args.ssh_options,
+            vault_address=cli_args.vault_address,
+            vault_mount=cli_args.vault_mount,
+            vault_secret=cli_args.vault_secret,
+            vault_password_field=cli_args.vault_password_field,
+            vault_username_field=cli_args.vault_username_field,
+            vault_username_from_vault=vault_username_from_vault,
         )
 
         if combined_init_cmd:

{mycli-2.2.0 → mycli-2.4.0}/mycli/clibuffer.py

@@ -42,6 +42,7 @@ def _multiline_exception(text: str) -> bool:
             # or ended with certain commands
             "\\g",
             "\\G",
+            "\\x",
             r"\e",
             r"\edit",
             r"\clip",

{mycli-2.2.0 → mycli-2.4.0}/mycli/client.py

@@ -58,9 +58,9 @@ class MyCli(AppStateMixin, OutputMixin, ClientCommandsMixin, ClientConnectionMix
 
     # check XDG_CONFIG_HOME exists and not an empty string
     xdg_config_home = os.environ.get("XDG_CONFIG_HOME", "~/.config")
+    xdg_config_file = os.path.join(os.path.expanduser(xdg_config_home), "mycli", "myclirc")
     system_config_files: list[str | IO[str]] = [
         "/etc/myclirc",
-        os.path.join(os.path.expanduser(xdg_config_home), "mycli", "myclirc"),
     ]
 
     def __init__(
@@ -72,7 +72,7 @@ class MyCli(AppStateMixin, OutputMixin, ClientCommandsMixin, ClientConnectionMix
         login_path: str | None = None,
         auto_vertical_output: bool = False,
         warn: bool | None = None,
-        myclirc: str = "~/.myclirc",
+        myclirc: str | None = None,
         show_warnings: bool | None = None,
         cli_verbosity: int = 0,
     ) -> None:
@@ -87,6 +87,12 @@ class MyCli(AppStateMixin, OutputMixin, ClientCommandsMixin, ClientConnectionMix
         self.sandbox_mode: bool = False
         self.checkpoint: IO | None = None
 
+        if myclirc is None:
+            if os.path.exists(self.xdg_config_file):
+                myclirc = self.xdg_config_file
+            else:
+                myclirc = '~/.myclirc'
+
         # Load config.
         config_files: list[str | IO[str]] = self.system_config_files + [myclirc]
 
@@ -114,10 +120,15 @@ class MyCli(AppStateMixin, OutputMixin, ClientCommandsMixin, ClientConnectionMix
         self.dsn_alias: str | None = None
         self.main_formatter = TabularOutputFormatter(format_name=c["main"]["table_format"])
         self.redirect_formatter = TabularOutputFormatter(format_name=c["main"].get("redirect_format", "csv"))
+        self.explorer_formatter = TabularOutputFormatter(format_name=c['explorer'].get('format', self.main_formatter))
         sql_format.register_new_formatter(self.main_formatter)
         sql_format.register_new_formatter(self.redirect_formatter)
+        sql_format.register_new_formatter(self.explorer_formatter)
         self.main_formatter.mycli = self
         self.redirect_formatter.mycli = self
+        self.explorer_formatter.mycli = self
+        self.explorer_command = c['explorer'].get('explorer_command')
+        self.explorer_trim_footer = c['explorer'].as_bool('trim_footer')
         self.syntax_style = c["main"]["syntax_style"]
         self.verbosity = -1 if c["main"].as_bool("less_chatty") else 0
         if cli_verbosity:
@@ -155,7 +166,7 @@ class MyCli(AppStateMixin, OutputMixin, ClientCommandsMixin, ClientConnectionMix
                 self.echo("Error: Unable to open the audit log file. Your queries will not be logged.", err=True, fg="red")
                 self.logfile = False
 
-        self.completion_refresher = CompletionRefresher()
+        self.completion_refresher = CompletionRefresher(self._invalidate_prompt_session)
         self.prefetch_schemas_mode = c["main"].get("prefetch_schemas_mode", "always") or "always"
         raw_prefetch_list = c["main"].as_list("prefetch_schemas_list") if "prefetch_schemas_list" in c["main"] else []
         self.prefetch_schemas_list = [s.strip() for s in raw_prefetch_list if s and s.strip()]
@@ -201,6 +212,10 @@ class MyCli(AppStateMixin, OutputMixin, ClientCommandsMixin, ClientConnectionMix
         self.destructive_keywords = destructive_keywords_from_config(c)
         special.set_destructive_keywords(self.destructive_keywords)
 
+    def _invalidate_prompt_session(self) -> None:
+        if self.prompt_session:
+            self.prompt_session.app.invalidate()
+
     def close(self) -> None:
         try:
             self.schema_prefetcher.stop()