Skip to main content

CLI for Sphinx AI

Project description

🚀 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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sphinx_ai_cli-0.9.16.tar.gz (1.2 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

sphinx_ai_cli-0.9.16-py3-none-any.whl (1.2 MB view details)

Uploaded Python 3

File details

Details for the file sphinx_ai_cli-0.9.16.tar.gz.

File metadata

  • Download URL: sphinx_ai_cli-0.9.16.tar.gz
  • Upload date:
  • Size: 1.2 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.7

File hashes

Hashes for sphinx_ai_cli-0.9.16.tar.gz
Algorithm Hash digest
SHA256 dc3bea68f170a898ccae661f4ac365d5399379e52e3812c386d26936e1d4e7a4
MD5 21d93f1e76e2e580188506f18cfb90f7
BLAKE2b-256 d24a0339d2975a1b309cbb71d342352f402f28add262cb08076bd4f6494cd232

See more details on using hashes here.

File details

Details for the file sphinx_ai_cli-0.9.16-py3-none-any.whl.

File metadata

  • Download URL: sphinx_ai_cli-0.9.16-py3-none-any.whl
  • Upload date:
  • Size: 1.2 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.7

File hashes

Hashes for sphinx_ai_cli-0.9.16-py3-none-any.whl
Algorithm Hash digest
SHA256 6237eef26f4b1d2a4a4d52f50082d4f6d37cd8d51f417b91394f983a0766b594
MD5 cdf2a6b98bc8c817fb49dde6bbeb8f4c
BLAKE2b-256 0b2fbdb186f25470fe092f23ae520e61016e63072fa6c9f3a9c53257904a4769

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page