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 ingest 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.7.0.tar.gz (72.4 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.7.0-py3-none-any.whl (84.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: spikuit_cli-0.7.0.tar.gz
  • Upload date:
  • Size: 72.4 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.7.0.tar.gz
Algorithm Hash digest
SHA256 0b53ed1ada63a2bed43b53b115d16940fa0f3ccd192e80191f1bac04b4071ecf
MD5 07d7659e592f02fcabb3b47211c637dd
BLAKE2b-256 371ffafe1b4715f032cd3799acaf9d3995cf31465d4090c0b0c68ea1eadf6871

See more details on using hashes here.

Provenance

The following attestation bundles were made for spikuit_cli-0.7.0.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.7.0-py3-none-any.whl.

File metadata

  • Download URL: spikuit_cli-0.7.0-py3-none-any.whl
  • Upload date:
  • Size: 84.2 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.7.0-py3-none-any.whl
Algorithm Hash digest
SHA256 a585b0a3b2cf7399aca8e0d39460e8bf8f80728a02d66a90865ad1993caf9e84
MD5 4b2120bca7f9d055dc117805b2985377
BLAKE2b-256 4e4c3f35f369e18f7f2055d27d351612cb0bc3d6a8501d3c1dbe3c98ee0f12cb

See more details on using hashes here.

Provenance

The following attestation bundles were made for spikuit_cli-0.7.0-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