Skip to main content

SpAIder install wizard, agent management, and Claude Code skill installer

Project description

spaider-cli

The official command-line interface for SpAIder, the memory infrastructure for AI agents.

spaider-cli is the recommended way to install, manage, and integrate SpAIder with your AI coding tools (Claude Code, Cursor, and others). It takes you from "never heard of SpAIder" to "working Studio + MCP-integrated Claude Code with a memory skill loaded" in one command.

pipx install spaider-cli
spaider init

Status

v0.1.0. All commands implemented and working.

Command Status
spaider --version / --help
spaider init ✅ One-shot setup wizard
spaider doctor ✅ Read-only health audit
spaider agent create / list / rotate-key / delete
spaider mcp install ✅ Claude Code + Cursor

What it does

  1. spaider init: one command from clone to a working, MCP-integrated stack:

    • Detect Docker (CLI + daemon).
    • Prompt for the LLM provider (OpenAI / Anthropic / Ollama) and validate the key with a live probe.
    • Generate the secrets you shouldn't have to type (JWT, connector key, Neo4j password) and write .env. Re-run safe: existing secrets are preserved, never regenerated, so re-running never locks the stack out of its own database.
    • Start the Docker stack and wait for /health.
    • Provision a dev-${USER} agent (or --agent <name>) and capture its key.
    • Install the MCP server + skill into ~/.claude/ (idempotent merge).

    Flags: --provider, --llm-key, --llm-base-url, --skip-docker, --skip-mcp, --agent.

  2. spaider doctor: read-only audit covering Docker, .env, LLM key, backend /health, embedding-dimension consistency, and the ~/.claude MCP + skill wiring. Exit 0 when all green/warn, 1 on a blocking failure.

  3. spaider agent ...: create / list / rotate-key / delete agents against the REST API (resolves agents by name).

  4. spaider mcp install: non-destructively merge SpAIder into your MCP client config (--for claude-code | cursor, --scope user | project); also writes the agent-side skill file so LLMs reflexively know when to call SpAIder.

The skill file

A key part of the value: spaider mcp install ships not just the MCP server config but a skill file (~/.claude/skills/spaider.md) that tells the LLM when and why to use SpAIder's tools. Without it, MCP tools sit unused. With it, the LLM proactively reaches for SpAIder when the conversation warrants, exactly like Read/Edit/Bash are reflexive in Claude Code today.

Source content is at src/spaider_cli/skills/claude_code.md (Apache 2.0); copy and adapt for your own tools if useful.

Development

git clone https://github.com/Spaider-studio/spaider.git
cd spaider/cli
pip install -e ".[dev]"
pytest

Or from the SpAIder monorepo root:

make cli-dev    # editable install of the CLI
make cli-test   # run cli/tests/

Release (maintainers only)

CI runs as the cli-tests job of .github/workflows/ci.yml (every PR + push to main that touches cli/); releases run from .github/workflows/cli-release.yml on tag push.

One-time setup before the first PyPI release:

  1. Create a PyPI account for the project.

  2. Register a Trusted Publisher (pending publisher) for spaider-cli:

    • PyPI Project → Publishing → Add a new pending publisher.
    • Owner: Spaider-studio, repo: spaider, workflow: cli-release.yml, environment: pypi.
    • GitHub: Settings → Environments → Create environment named pypi (no protection rules needed for the first release).
  3. Tag and push (CLI releases use namespaced cli/v* tags; plain v* tags release the container images instead):

    git tag cli/v0.1.0
    git push origin cli/v0.1.0
    

    The workflow builds sdist + wheel, runs twine check, then publishes via the OIDC trusted-publisher flow (no API tokens stored in the repo).

To rehearse without publishing, use the manual workflow_dispatch trigger with dry_run: true: it builds the artifacts but skips PyPI.

License

Apache 2.0. See LICENSE.

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

spaider_cli-0.1.1.tar.gz (41.1 kB view details)

Uploaded Source

Built Distribution

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

spaider_cli-0.1.1-py3-none-any.whl (36.7 kB view details)

Uploaded Python 3

File details

Details for the file spaider_cli-0.1.1.tar.gz.

File metadata

  • Download URL: spaider_cli-0.1.1.tar.gz
  • Upload date:
  • Size: 41.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for spaider_cli-0.1.1.tar.gz
Algorithm Hash digest
SHA256 a16c025b410115b106e55b7d974c7d22c10d6eb7337b9c72ec5e6a55597c0efb
MD5 93d1db2ae7a88fdaf3363cf941bcd72d
BLAKE2b-256 dcc16e80dfc1001213a2837726b650607d867f8a0f7561dbcae8b18e86737434

See more details on using hashes here.

Provenance

The following attestation bundles were made for spaider_cli-0.1.1.tar.gz:

Publisher: cli-release.yml on Spaider-studio/spaider

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file spaider_cli-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: spaider_cli-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 36.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for spaider_cli-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 a1773052535ddacda9356b294bfb78f5bb23155db0033fc006e238fbf3dab8a1
MD5 15cbdcd3773ba7284c2b429b4ec1bf57
BLAKE2b-256 cfd88d4314d74711eeec2d9a4e658699389fd9b038e9fbaddb9d8cd7399b2aff

See more details on using hashes here.

Provenance

The following attestation bundles were made for spaider_cli-0.1.1-py3-none-any.whl:

Publisher: cli-release.yml on Spaider-studio/spaider

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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