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.6.2.tar.gz (61.5 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.6.2-py3-none-any.whl (73.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: spikuit_cli-0.6.2.tar.gz
  • Upload date:
  • Size: 61.5 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.6.2.tar.gz
Algorithm Hash digest
SHA256 5995a300cdfe942b2e0fc945c4be498390f33aba572f0b9e2713cbd601704627
MD5 56c238c54a2f9323a29a763bde455c09
BLAKE2b-256 c1a4f1a801e5fd5560694af7b058cbaf1dac92b09a2ba95a0562e8d057098a5c

See more details on using hashes here.

Provenance

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

File metadata

  • Download URL: spikuit_cli-0.6.2-py3-none-any.whl
  • Upload date:
  • Size: 73.4 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.6.2-py3-none-any.whl
Algorithm Hash digest
SHA256 dacfa565a2f6c7a40a997a2c90375fd29872c903963e324f33a3989f6108cd25
MD5 2bd3423327c55fdd2f6112e8efdf405d
BLAKE2b-256 e1c2bd15b034c95d5984d3fdf743f10cd7c7c0a71a1d31e42396e316ad051e89

See more details on using hashes here.

Provenance

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