SignalPilot Installer CLI
This installer CLI is a bootstrap installer that sets up the SignalPilot-AI Jupyter extension in one command.
The CLI is NOT the product. It's a convenience installer. The SignalPilot Jupyter extension (agentic harness) is the actual product.
What You're Installing
SignalPilot is a Jupyter-native AI agentic harness that investigates data by connecting to your organizational context:
Four core capabilities:
- 🔌 Multi-Source Context — Auto-connects to db warehouse, dbt lineage, query history, Slack threads, Jira tickets, and past investigations via MCP
- 🔄 Long-Running Agent Loop — Plans, executes, iterates until task complete with analyst-in-the-loop approval (not single-shot completions)
- 🧠 Multi-Session Memory — Remembers past hypotheses, validated assumptions, known data quirks across investigations
- 📚 Skills & Rules — Custom analysis patterns (skills) + team coding standards (rules) + business logic
Security: Zero data retention • Read-only access • Local-first execution • SOC 2 in progress
Quick Install
Prerequisites: macOS, Linux, or Windows (WSL) • Internet connection
Don't have uv? Install it first (takes 10 seconds):
curl -LsSf https://astral.sh/uv/install.sh | sh
Install SignalPilot:
uvx signalpilot
What happens:
- Creates
~/SignalPilotHomeworkspace with starter notebooks - Installs isolated Python 3.12 + Jupyter Lab + SignalPilot extension
- Installs data packages (pandas, numpy, matplotlib, seaborn, plotly)
- Optimizes Jupyter cache for fast startup
- Launches Jupyter Lab at
http://localhost:8888
Time: ~2 minutes
Why uv?
- 10-100x faster than pip/conda for package installation
- SignalPilot runs on it — native integration with kernel
- Modern Python package management with better dependency resolution
Launch Jupyter Lab Anytime
Once installed, start Jupyter Lab with:
uvx signalpilot lab
What this does:
- Opens Jupyter Lab in your current directory
- Uses home environment from
~/SignalPilotHome/.venv - SignalPilot extension pre-loaded
- Opens browser at
http://localhost:8888
⚠️ Smart Detection: If a local .venv with jupyter is detected in your current directory, you'll see a red warning. Use --project flag to use it instead.
Keeping SignalPilot Updated
SignalPilot automatically checks for updates when you launch Jupyter Lab. When an update is available, you'll see a notification:
For minor updates:
╭─────────────── 📦 SignalPilot Update ───────────────╮
│ Update Available: 0.11.8 (installed: 0.11.7) │
│ Run 'sp upgrade' to update │
╰──────────────────────────────────────────────────────╯
For major updates:
╭─────────────── 📦 SignalPilot Update ───────────────╮
│ Important Update: 0.12.0 (installed: 0.11.7) │
│ This is a MAJOR update │
╰──────────────────────────────────────────────────────╯
Upgrade now? [y/n] (n):
Manual Upgrade
Upgrade both the CLI and library anytime:
uvx signalpilot upgrade
Upgrade your project's local environment:
cd /path/to/project
uvx signalpilot upgrade --project
Note: Update checks happen in the background and never slow down Jupyter startup. You can disable them in ~/SignalPilotHome/.signalpilot/config.toml if desired.
📖 Full upgrade guide: docs/UPGRADE-USER-GUIDE.md
What Gets Installed
Python Packages:
signalpilot-ai— AI agent integration (the actual product)jupyterlab— Modern Jupyter interfacepandas,numpy— Data manipulationmatplotlib,seaborn,plotly— Visualizationpython-dotenv,tomli— Configuration utilities
Directory Structure:
~/SignalPilotHome/
├── user-skills/ # Custom analysis patterns
├── user-rules/ # Team coding standards
├── team-workspace/ # Shared notebooks (git-tracked)
├── demo-project/ # Example notebooks
├── pyproject.toml # Python project config
├── start-here.ipynb # Quick start guide
└── .venv/ # Python environment
Working in Different Modes
SignalPilot offers three ways to launch Jupyter Lab:
Default Mode (Current Folder + Home Environment)
cd ~/projects/my-analysis
uvx signalpilot lab
What this does:
- Opens Jupyter Lab in your current directory
- Uses home environment from
~/SignalPilotHome/.venv - Perfect for quick exploration without setting up new environment
⚠️ Warning: If you have a local .venv with jupyter, you'll see a red warning prompting you to use --project flag.
Project Mode (Current Folder + Local Environment)
cd ~/projects/custom-analytics
uvx signalpilot lab --project
What this does:
- Opens Jupyter Lab in your current directory
- Uses local
.venvin that directory (fails if missing) - Great for project-specific work with custom dependencies
Requirements:
- A
.venvmust exist in current directory - Must have
jupyterlabandsignalpilot-aiinstalled
Create project environment:
mkdir ~/projects/custom-analytics && cd ~/projects/custom-analytics
uv venv --seed --python 3.12
source .venv/bin/activate
uv pip install jupyterlab signalpilot-ai pandas numpy matplotlib plotly
uvx signalpilot lab --project
Home Mode (SignalPilotHome Workspace + Home Environment)
uvx signalpilot lab --home
# Or use the shortcut:
uvx signalpilot home
What this does:
- Opens Jupyter Lab in
~/SignalPilotHomedirectory - Uses home environment from
~/SignalPilotHome/.venv - Default workspace with all your skills, rules, and team notebooks
Pass Jupyter Lab Arguments
You can pass any Jupyter Lab flags after the command:
# Custom port
uvx signalpilot lab --port=8889
# Disable browser auto-open
uvx signalpilot lab --no-browser
# Combine with mode flags
uvx signalpilot lab --project --port=8889
uvx signalpilot home --no-browser
# Bind to all interfaces (remote access)
uvx signalpilot lab --ip=0.0.0.0 --port=9999
All standard jupyter lab arguments work.
Alternative Installation Methods
Option 1: Run with uvx (Recommended)
uvx signalpilot
No permanent installation needed. Perfect for most users. Always gets the latest version.
Option 2: Install with uv tool
uv tool install signalpilot
sp init
Installs sp command globally. Use sp lab, sp home to launch later.
Note: Global installations don't auto-update. Reinstall periodically:
uv tool install --force signalpilot
Option 3: Install with pip
pip install signalpilot
sp init
Works but slower than uv (10-100x). May have dependency conflicts.
Requirements
- Python 3.10 or higher
- uv package manager (recommended)
Links
License
MIT License - See LICENSE file for details
Metadata
Release files for signalpilot 0.7.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| signalpilot-0.7.1.tar.gz | 430.7 kB | Without provenance | Details for signalpilot-0.7.1.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| signalpilot-0.7.1-py3-none-any.whl | Python 3 | none | any | Details for signalpilot-0.7.1-py3-none-any.whl |
Total release size: 457.2 kB
Release files / signalpilot-0.7.1.tar.gz
| Download URL | signalpilot-0.7.1.tar.gz |
|---|---|
| Size | 430.7 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
0a97c55fe828b959c6ce3ea35374771ca8858a7b7a1391d3622e092f896b42ae
|
|
BLAKE2b-256 checksum How to use checksums |
03b208cd4f3117557290d882260d76bbda1e903ea6ab9c1b76add710ff8a3dd5
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.9.25 {"installer":{"name":"uv","version":"0.9.25","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}
|
Release files / signalpilot-0.7.1-py3-none-any.whl
| Download URL | signalpilot-0.7.1-py3-none-any.whl |
|---|---|
| Size | 26.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
6a7c37c0b8d6ce80c71d5b99041b9021c4635b65d601d187b21091323f2ffd39
|
|
BLAKE2b-256 checksum How to use checksums |
85fe92c4dd0daa47f02d28f3b93621f8b7649871b1eb2bbc7760ebe59925f06a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.9.25 {"installer":{"name":"uv","version":"0.9.25","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}
|
Security for signalpilot 0.7.1
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.