Skip to main content

​
CLI Options

This page contains a reference for all available command-line options supported by the Sphinx CLI.

​
Help

​
-h, --help

Show help message and exit.

​
Notebook Configuration

​
--notebook-filepath NOTEBOOK_FILEPATH

Path to notebook file. This option is optional - if not provided, the CLI will prompt for selection interactively.

​
Sphinx Service

​
--sphinx-url SPHINX_URL

URL of the Sphinx service to connect to.

​
--sphinx-rules-path SPHINX_RULES_PATH

Path to a custom rules file for Sphinx behavior customization. Default is local to the Jupyter Notebook. For more information about writing custom Sphinx rules, see the Rules documentation.

​
Jupyter Server

​
--jupyter-server-url JUPYTER_SERVER_URL

URL of an existing Jupyter server to connect to (optional). If not provided, a new server will be started for this session, and destroyed on completion.

​
--jupyter-server-token JUPYTER_SERVER_TOKEN

Authentication token for the Jupyter server. Required only when using an existing server with token authentication.

​
Memory Features

For more information about Sphinx’s memory system, see the Memories documentation.

​
--no-memory-read

Disable memory read capability. By default, the CLI will utilize Sphinx’s semantic cache to make the best decisions and learnings from previous invocations.

​
--no-memory-write

Disable memory writing capability from the CLI. By default, memory write is enabled. This means that the CLI will not modify the user’s semantic cache that it keeps up to date about learnings and other details about working in the user’s environment.

​
Environment Management

​
--no-package-installation

Disable automatic package installation. By default, Sphinx will attempt to install missing libraries that are necessary for data science.

​
--no-ripgrep-installation

Disable automatic ripgrep binary installation. By default, Sphinx will attempt to use, if available, or install RipGrep to efficiently search through files from the Jupyter Kernel.

​
Cell Behavior

​
--no-collapse-exploratory-cells

Disable automatic collapsing of exploratory cells. By default, exploratory cells are collapsed.

​
Tool Features

Disable file search tools (grep, ls, read). By default, file search tools are enabled. Disable web search tools. By default, web search tools are enabled.

​
Logging

​
-v, --verbose

Enable verbose mode to show detailed messages during execution.

​
-l, --log-level {debug,info,warn,error,fatal}

Set the log level when verbose mode is enabled. Available levels are:
  • debug: Most detailed logging
  • info: General informational messages (default)
  • warn: Warning messages
  • error: Error messages
  • fatal: Fatal error messages only