Skip to main content

spectackl

Command-line interface to the Spectackl Public REST API — built for AI agents and operators who need programmatic access to artifacts, scenes and task executions without going through the web UI.

pipx install spectackl   # isolated venv, binary on PATH
# or
pip install spectackl

Upgrading

pipx install --force spectackl

--force rather than pipx upgrade, and rather than a bare pipx install. A bare install leaves an existing app untouched (pip inside its venv reports "Requirement already satisfied"), and pipx upgrade re-resolves whatever spec the app was first installed from — so an app installed once from a local path or a pin will keep reinstalling that, however many releases have been published since. --force discards the venv and resolves the latest release from PyPI. Under pip, the equivalent is pip install --upgrade spectackl.

Check what landed with spectackl --version. If it still reports the old number, pip's index cache is stale — add --pip-args="--no-cache-dir".

Quick start

spectackl init --api-key spc_… --backend-url https://api.spectackl.ai --project my-project
spectackl artifact list --json

API keys are managed in the Spectackl Admin Console. init writes .spectackl/settings.yaml in the current directory and a user-global ~/.config/spectackl/settings.yaml; both are created 0600 and neither should be committed.

What it does

Command Purpose
spectackl search <query> Hybrid full-text + semantic search across a project's content
spectackl artifact Get, list, create and update artifacts
spectackl relation Manage the artifact graph (INCLUDES, DOCUMENTS, DEPENDS_ON, …)
spectackl context Inspect scenes (work contexts) and the artifacts they scope
spectackl task Claim, progress and complete task executions
spectackl assets sync Materialize the project's agents and skills into ./.claude/
spectackl rsync Reconcile artifact content with local files, in both directions
spectackl daemon Run agent sessions on this machine

Every command accepts --json for machine-readable output, and every command returns a documented exit code — 0 success, 10 auth required, 20 validation, 30 not found, 40 upstream unavailable, and so on — so scripts can branch on failures precisely rather than parsing text.

Designed for agents

Output is stable and parseable, errors are structured, and the exit-code scheme is part of the public contract. spectackl assets sync writes agent and skill definitions in the exact layout Claude Code reads, built from the same artifacts the platform provisions into a sandbox — so an agent invoked on a workstation is the one that runs in production.

Requirements

  • Python 3.10+
  • A Spectackl tenant and an API key (spc_ prefix)

Documentation

Full guide: https://docs.spectackl.ai

License

MIT

Metadata

Release files for spectackl 1.5.3

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

Source distribution (sdist)

Source distribution for spectackl 1.5.3
File Size Uploaded Provenance
spectackl-1.5.3.tar.gz 178.1 kB Without provenance Details

Built distribution (wheel)

Table of built distributions (wheels) for spectackl 1.5.3
File Interpreter ABI Platform
spectackl-1.5.3-py3-none-any.whl Python 3 none any Details

Total release size: 318.5 kB

Release files / spectackl-1.5.3.tar.gz

Download URL spectackl-1.5.3.tar.gz
Size 178.1 kB
Tags Source
SHA-256 checksum
How to use checksums
e011d1017a5761fc201ea65cfdd7e77d6d5ea99d32c116fd6bc900229744b908
BLAKE2b-256 checksum
How to use checksums
43812252c2e658e986c9269e450a9f27de02f78d321a86f55f9161df7ff998a0
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.12.15

Release files / spectackl-1.5.3-py3-none-any.whl

Download URL spectackl-1.5.3-py3-none-any.whl
Size 140.5 kB
Tags Python 3
SHA-256 checksum
How to use checksums
f0acf2429d9e99c6824021392cd69b7e0f797034c7d5bffed9e7f0ef92990093
BLAKE2b-256 checksum
How to use checksums
6de9089a4620aad8af0818d0fa87acfed49d21f2453c90bc603f751deb20b2f3
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.12.15

Security for spectackl 1.5.3

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.

Release history Release notifications | RSS feed

This release

1.5.3 This release

2 release files No provenance

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