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-1.0.6.tar.gz (2.0 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-1.0.6-py3-none-any.whl (2.0 MB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: sphinx_ai_cli-1.0.6.tar.gz
  • Upload date:
  • Size: 2.0 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-1.0.6.tar.gz
Algorithm Hash digest
SHA256 d764e3a9d11350900b15b6cccfbb213d5363fa80e118234bceb40bdd0fe73148
MD5 e3825fdba464c7347acc8c8d04191e29
BLAKE2b-256 ddd30e403905950d9ab5ec0fed871a2aaa296f0b471b07175c1812e72e118d1f

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sphinx_ai_cli-1.0.6-py3-none-any.whl
  • Upload date:
  • Size: 2.0 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-1.0.6-py3-none-any.whl
Algorithm Hash digest
SHA256 376c495ae70ae9690500dcbb10cf98cba0eaac74d9a567bb42f53a00efd7b198
MD5 df4e63b229618b5fc7b3b2fae29e637c
BLAKE2b-256 37651981579fc563e79a067971ee8fec00a13628724f1af1eef64e575b577c02

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