asobi 0.5.1

A persistent, project-local knowledge graph CLI for AI agents.
Documentation

๐ŸŽฎ asobi

A persistent, project-local knowledge graph CLI for LLM agents.

Keep memory, track session state, and share context across conversations โ€” stored in a local, single-file libSQL/SQLite database.

CI Release License: MIT Built with Nix Rust

Last commit Stars


โœจ Features

  • Knowledge graph โ€” entities, append-only (capped) observations, and directed relations.
  • Truths โ€” durable keyโ†’value facts per entity for current state (status, version); status-as-truth makes a board a single search --where status=โ€ฆ.
  • Fast search โ€” search over libSQL FTS5 (BM25 relevance, porter stemming) with a substring fallback, plus --where key=value truth filters (the query term is optional).
  • Concurrency-safe โ€” WAL-mode storage with bounded startup and write retries, so lead and dispatched agents can share a graph.
  • Pluggable backend โ€” libSQL is the default; an experimental Turso backend is opt-in behind --features turso-experimental and keeps its own isolated state file.
  • Lazy reads โ€” graph/search return truths + counts; show returns the full body. Cheap to load, cheap on tokens.
  • Skills โ€” install reusable agent instructions from a git repo or local path.
  • Document tier (optional, --features documents) โ€” ingest + semantic query over Markdown.

๐Ÿ“ฆ Installation

From crates.io (recommended)

cargo install asobi
# with the optional document tier (semantic ingest + query):
cargo install asobi --features documents

Prebuilt binary (cargo-binstall)

No compile โ€” cargo-binstall pulls the binary from the GitHub release:

cargo binstall asobi

From source

cargo install --git https://github.com/azusachino/asobi

Or build locally with make build (graph CLI) or make build-documents (adds ingest/query/compact). Requires Rust 1.85+, Edition 2024.

๐Ÿš€ Quick Start

asobi init                  # one-time setup (XDG); use --local for a project-scoped graph

# Store and recall context (names are hierarchical, e.g. ame:mobile-support:task-1)
asobi obs "my-project" "Decided to use WAL mode for concurrency"
asobi truth "my-project" "status" "in-progress"
asobi search "WAL"
asobi show "my-project" --with-ids
asobi update-obs "my-project" 1 "Decided to use Turso multi-process WAL for concurrency" --id
asobi rm-obs "my-project" 1 --id

๐Ÿ’ป Common Commands

  • asobi graph / search <q> / search --where status=READY / show <name>... --expand part_of --with-ids โ€” read the graph (supports subtree expansions and sequential observation IDs).
  • asobi new <name> <type> --obs "..." / obs <name> "..." / update-obs <name> <old/id> <new> [--id] / rm-obs <name> <content/id> [--id] โ€” manage observations (supports updates and deletions by unique sequential IDs).
  • asobi truth <name> <key> <value> / rm-truth <name> <key> / history <name> [key] โ€” manage truths and read their change history (overwrites are archived with valid-time; history is opt-in and never shown in graph/search/show).
  • asobi skills install <src> --all / update / skills / skills show <name> โ€” manage skills (--all and update sync, pruning skills dropped upstream; --select is additive).
  • asobi stats / export -o graph.json / import graph.json / reset โ€” inspect & manage.
  • asobi backup / restore <snapshot> [--force] โ€” full-fidelity libSQL snapshots; see the usage guide.

๐Ÿ”’ Sandboxed Environments

When running in sandboxed or restricted environments (such as Codex, Nix build sandboxes, or containerized runners), use a project-local workspace (asobi init --local) or configure custom database paths (ASOBI_HOME, ASOBI_DATABASE_URL). The storage backend manages WAL coordination and retry behavior; legacy journal-mode and busy-timeout overrides are not supported.

See the Running in Sandboxed Environments section in the Usage Guide for more details.

๐Ÿ› ๏ธ Development

  • Task runner: make (Nix-wrapped). make check is the quality gate: rustfmt, Prettier, Ruff, Clippy with -D warnings, graph tests, document-feature tests, and both CLI verification scripts.
  • Rust quality standard: keep code rustfmt-clean, introduce no Clippy warnings, preserve single-threaded test isolation, and add regression coverage for behavior changes. Run make check before commits.
  • Coverage: with cargo-tarpaulin installed, run cargo tarpaulin --all-features --out Html --output-dir coverage and open coverage/index.html.
  • Benchmarks: run make bench; use performance profiling for Criterion baselines, DHAT allocations, and SQL plans.
  • See docs/usage.md for the full CLI reference, docs/workflow.md for the day-to-day and task dispatcher workflow, and docs/architecture.md for design.