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

Uploaded Python 3

File details

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

File metadata

  • Download URL: spikuit_cli-0.5.7.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.7.tar.gz
Algorithm Hash digest
SHA256 42a5f0bfc2142aef1c697f7e267df7022877abbf8098abd926bfc3cca91a7f19
MD5 72f83a69fc9ded98b12cf3deb9a0681a
BLAKE2b-256 74d11cc167d52850013b61eef7b7087e1009fac50718de694af6503fe47e526d

See more details on using hashes here.

Provenance

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

File metadata

  • Download URL: spikuit_cli-0.5.7-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.7-py3-none-any.whl
Algorithm Hash digest
SHA256 f48917bdca65100c8371ed4076d271df56b3efbb13f7b95440776987f773d2bc
MD5 c1c44f1b352e0c4caa4a1214e62c5d7c
BLAKE2b-256 1a5b832c9d157d9fc779516e5b7ad5b59bee7ce54353e375f38b95eab35eb743

See more details on using hashes here.

Provenance

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