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.8.tar.gz (34.1 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.8-py3-none-any.whl (41.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: spikuit_cli-0.5.8.tar.gz
  • Upload date:
  • Size: 34.1 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.8.tar.gz
Algorithm Hash digest
SHA256 3b634c33a6fe89cc1e71b67d90aeb233b05a64b4ac4439f15ec51a6b21983ff9
MD5 83d594d2546fc0a1b95ac429472ac357
BLAKE2b-256 0cb0a96a8c75689b8fb2957eb831e6d99e57f221e68a897af3718048d75e5e1f

See more details on using hashes here.

Provenance

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

File metadata

  • Download URL: spikuit_cli-0.5.8-py3-none-any.whl
  • Upload date:
  • Size: 41.8 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.8-py3-none-any.whl
Algorithm Hash digest
SHA256 03ae84de59a4b54fa49209433f0e8c9d7e309d1dd6f7ec040952222d407312b2
MD5 de094ab18173c23061ab58775e1b4482
BLAKE2b-256 0a7bd006e9ee79341280e9674435ae0f5fdcfa3235252fcca2f9024fd4708d77

See more details on using hashes here.

Provenance

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