Skip to main content

CLI interface for Spikuit (spkt command)

Project description

spikuit-cli

PyPI Python versions License

The spkt command — CLI for Spikuit, a knowledge base that gets smarter the more you use it.

⚠️ Pre-1.0 / under active development. Expect frequent breaking changes until v1.0.0.

spikuit-cli installs the spkt command and pulls in spikuit-core[engine] so you get the full Brain engine (FSRS + knowledge graph + spreading activation) out of the box.

pip install spikuit-cli
spkt --help

If you want the CLI plus everything else under one install target, use the spikuit metapackage instead.

Quick start

# Create a brain in the current directory
spkt init -p openai-compat \
  --base-url http://localhost:1234/v1 \
  --model text-embedding-nomic-embed-text-v1.5

# Ingest a source
spkt source learn https://en.wikipedia.org/wiki/Monad_(category_theory) -d math

# Search the graph
spkt retrieve "What is a monad?"

# Review what's due (FSRS)
spkt neuron due
spkt neuron fire <id> -g fire

# Export a read-only bundle for a server
spkt export qabot --output ./brain.db

Resource-oriented commands

Resource Subcommands
spkt neuron add, list, inspect, remove, merge, due, fire
spkt synapse add, remove, weight, list
spkt source learn, list, inspect, update, refresh
spkt domain list, rename, merge, audit
spkt community detect, list
spkt skills install, list

Plus root commands: init, config, stats, retrieve, quiz, visualize, embed-all, export, import, diagnose, progress.

All commands support --json for machine-readable output and --brain <path> to target a specific Brain.

Links

License

Apache-2.0

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

spikuit_cli-0.5.5.tar.gz (33.9 kB view details)

Uploaded Source

Built Distribution

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

spikuit_cli-0.5.5-py3-none-any.whl (41.7 kB view details)

Uploaded Python 3

File details

Details for the file spikuit_cli-0.5.5.tar.gz.

File metadata

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

File hashes

Hashes for spikuit_cli-0.5.5.tar.gz
Algorithm Hash digest
SHA256 b26df4e36a1abe2411bf9966c55134fe989a9c80ffed1aa93cce0eb6bbc8e8e4
MD5 07004f0df40a00d86bdf3818f5c7bee5
BLAKE2b-256 f3f2e8c92f4ca53a5213dfeac1ba4edb0acc1fe2274904046410d3c10487a4f4

See more details on using hashes here.

Provenance

The following attestation bundles were made for spikuit_cli-0.5.5.tar.gz:

Publisher: publish.yml on takyone/spikuit

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

File details

Details for the file spikuit_cli-0.5.5-py3-none-any.whl.

File metadata

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

File hashes

Hashes for spikuit_cli-0.5.5-py3-none-any.whl
Algorithm Hash digest
SHA256 0f503c9d8bd8ca85168e49dfdcca9850312736f6fba088d41e6b7a8227fe32d9
MD5 8b2e17dc25d06f81d0d93020a0bfa805
BLAKE2b-256 99dfe7a4c2a2a4f28a70139425f15c0696dd57c4c0a0c51d48485013e322b122

See more details on using hashes here.

Provenance

The following attestation bundles were made for spikuit_cli-0.5.5-py3-none-any.whl:

Publisher: publish.yml on takyone/spikuit

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