Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.sphinx.ai/llms.txt

Use this file to discover all available pages before exploring further.

​
Installation

To install the Sphinx CLI, use pip: 
pip install sphinx-ai-cli
Note: You may need to use pip3 or a virtual environment depending on your system setup.

​
Getting Started

Invoke the Sphinx CLI by providing the path to an existing notebook, along with a prompt for the agent to work on. By default, the CLI will create a Jupyter server for Sphinx to operate: 
sphinx-cli chat --notebook-filepath <path> --prompt <prompt>
For example: 
sphinx-cli chat \
  --notebook-filepath notebooks/example.ipynb \
  --prompt "Analyze and summarize the notebook results."
For a list of all available CLI arguments and options, run: 
sphinx-cli chat --help