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

Uploaded Python 3

File details

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

File metadata

  • Download URL: sphinx_ai_cli-1.1.0.tar.gz
  • Upload date:
  • Size: 2.1 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.1.0.tar.gz
Algorithm Hash digest
SHA256 3e4eca61d3ccd5bc10565e1d719080bdb98bf74d0ff2910ac42b372362e79e6f
MD5 5ea35ca379007173eef424837966f9a4
BLAKE2b-256 070847421fb5a734ef8c5a86b5ff4bc17baa24ad6dac56436798705aabcf28d3

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sphinx_ai_cli-1.1.0-py3-none-any.whl
  • Upload date:
  • Size: 2.1 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.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 b4008057ad9c1455c08ad201141d381665dbafa30bfe81c621454a29dc6ff958
MD5 e1fe968929fa870fbe3df98cc0aaa02c
BLAKE2b-256 8bd047d4947fc2a6b84911632e5e17119c506a6f4b7407e3e9e785c142a68e5f

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