Skip to main content

🚀 Quick Start

# Start Sphinx CLI (interactive mode by default)
sphinx-cli

🎨 Interactive Mode (Default)

Running sphinx-cli starts an interactive terminal-based chat interface similar to Claude Code or Cursor agent:

Features:

  • Notebook Selection: Automatically scans your directory for .ipynb files and lets you choose one
  • Notebook Creation: Prompts to create a new notebook if none are found in your directory
  • Beautiful UI: Clean terminal interface with minimal design
  • Thinking Indicators: Shows cycling verbs in dim cyan while Sphinx processes (Thinking, Analyzing, Processing, Debugging, etc.)
  • Conversational Chat: Type natural language prompts and get responses
  • Real-time Feedback: See processing status with animated indicators

Usage:

# Start interactive mode (default - will prompt for notebook selection or creation)
sphinx-cli

# Start with a specific notebook (creates it if it doesn't exist)
sphinx-cli --notebook-filepath ./my-notebook.ipynb

# Use with existing Jupyter server
sphinx-cli --jupyter-server-url http://localhost:8888 --jupyter-server-token your_token

In Interactive Mode:

  • Type your questions naturally at the > prompt
  • See real-time thinking indicators while Sphinx works
  • Type exit to end the session
  • Press Ctrl+C to interrupt at any time

📋 Commands

  • sphinx-cli - Start interactive chat mode (default)
  • sphinx-cli login - Authenticate with Sphinx (opens web browser)
  • sphinx-cli logout - Clear stored authentication tokens
  • sphinx-cli status - Check authentication status
  • sphinx-cli chat --notebook-filepath <path> --prompt <prompt> - Run a single non-interactive chat

Metadata

Release files for sphinx-ai-cli 1.1.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for sphinx-ai-cli 1.1.0
File Size Uploaded
sphinx_ai_cli-1.1.0.tar.gz 2.1 MB Details

Built distribution (wheel)

Table of built distributions (wheels) for sphinx-ai-cli 1.1.0
File Interpreter ABI Platform
sphinx_ai_cli-1.1.0-py3-none-any.whl Python 3 none any Details

Total release size: 4.2 MB

Release files / sphinx_ai_cli-1.1.0.tar.gz

Download URL sphinx_ai_cli-1.1.0.tar.gz
Size 2.1 MB
Tags Source
SHA-256 checksum
How to use checksums
3e4eca61d3ccd5bc10565e1d719080bdb98bf74d0ff2910ac42b372362e79e6f
BLAKE2b-256 checksum
How to use checksums
070847421fb5a734ef8c5a86b5ff4bc17baa24ad6dac56436798705aabcf28d3
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.13.7

Release files / sphinx_ai_cli-1.1.0-py3-none-any.whl

Download URL sphinx_ai_cli-1.1.0-py3-none-any.whl
Size 2.1 MB
Tags Python 3
SHA-256 checksum
How to use checksums
b4008057ad9c1455c08ad201141d381665dbafa30bfe81c621454a29dc6ff958
BLAKE2b-256 checksum
How to use checksums
8bd047d4947fc2a6b84911632e5e17119c506a6f4b7407e3e9e785c142a68e5f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.13.7

Release history Release notifications | RSS feed

This release

1.1.0 This release

2 release files

1.0.6

2 release files

1.0.3

2 release files

1.0.0

2 release files

0.9.16

2 release files

0.9.15

2 release files

0.9.14

2 release files

0.9.13

2 release files

0.9.12

2 release files

0.9.0

2 release files

0.8.2

2 release files

0.7.10

2 release files

0.7.0

2 release files

0.6.3

2 release files

0.6.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page