Metadata-Version: 2.4
Name: spikuit-cli
Version: 0.5.6
Summary: CLI interface for Spikuit (spkt command)
License-Expression: Apache-2.0
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Education
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Education
Requires-Python: >=3.11
Requires-Dist: pyvis>=0.3.2
Requires-Dist: spikuit-core[engine]
Requires-Dist: typer>=0.24.1
Description-Content-Type: text/markdown

# spikuit-cli

[![PyPI](https://img.shields.io/pypi/v/spikuit-cli.svg)](https://pypi.org/project/spikuit-cli/)
[![Python versions](https://img.shields.io/pypi/pyversions/spikuit-cli.svg)](https://pypi.org/project/spikuit-cli/)
[![License](https://img.shields.io/github/license/takyone/spikuit.svg)](https://github.com/takyone/spikuit/blob/main/LICENSE)

**The `spkt` command — CLI for [Spikuit](https://github.com/takyone/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]`](https://pypi.org/project/spikuit-core/) so you get
the full Brain engine (FSRS + knowledge graph + spreading activation) out of
the box.

```bash
pip install spikuit-cli
spkt --help
```

If you want the CLI plus everything else under one install target, use the
[`spikuit`](https://pypi.org/project/spikuit/) metapackage instead.

## Quick start

```bash
# 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

- **Documentation**: <https://takyone.github.io/spikuit/>
- **CLI reference**: <https://takyone.github.io/spikuit/cli/>
- **Source**: <https://github.com/takyone/spikuit>
- **Issues**: <https://github.com/takyone/spikuit/issues>

## License

Apache-2.0
