Skip to main content

Agent + CLI that turns Claude into a private Spanish tutor: track progress, get an overview, get advice, read stories, and learn & practice Spanish (written and spoken) online from your phone.

Project description

spanish-cli

Agent + CLI that turns Claude into a private Spanish tutor: track progress, get an overview, get advice, read stories, and learn & practice Spanish (written and spoken) online from your phone.

What you get

  • An agent-first CLI cited from teken (afi-cli) — the runtime package has no third-party dependencies.
  • A mesh identityculture.yaml (suffix + backend) and the matching resident prompt file (AGENTS.colleague.md, since this template runs backend: colleague).
  • The canonical guildmaster skill kit (14 skills) under .claude/skills/, vendored cite-don't-import. See docs/skill-sources.md.
  • A build + deploy baseline — pytest, lint, the agent-first rubric gate, and PyPI Trusted Publishing wired into GitHub Actions.

Quickstart

uv sync
uv run pytest -n auto                 # run the test suite
uv run spanish whoami                  # identity from culture.yaml
uv run spanish learn                   # self-teaching prompt (add --json)
uv run teken cli doctor . --strict    # the agent-first rubric gate CI runs

The installed command is spanish; the PyPI package and repo are spanish-cli. spanish explain spanish and spanish explain spanish-cli both resolve to the root doc entry.

CLI

spanish-cli is an LLM-free tutor engine that implements the learn subject-plugin contract: it owns the committed Spanish content (stories, lessons, exercises) and each learner's mastery state, resolves what to teach next, and emits structured teaching directives. The driving agent (or human) does the conversational tutoring the directive describes, grades pass|partial|fail, and writes the result back with record. spanish never converses, grades free text, or computes scores — learn-cli's motivation layer does the scoring.

Tutor verbs (the contract surface)

Verb What it does Payload kind
spanish overview Subject self-description: modules + content counts. subject_overview
spanish progress The learner's mastery, counters, and next step. progress
spanish advice Deterministic study advice from stored state. advice
spanish story list | read <id> Graded stories + a reading directive. story_list / story_read
spanish lesson start | next | repeat Teaching directives from the curriculum. lesson_directive
spanish practice [<scope>] A batch of exercises to run (no scope = review). practice_directive
spanish record --item <id> --result … Write back one graded outcome; updates mastery. record_ack
spanish doctor Self-check + the pinned contract version. subject_doctor

Agent-first verbs

Verb What it does
spanish whoami Report this agent's nick, version, backend, and model from culture.yaml.
spanish learn Print a structured self-teaching prompt.
spanish explain <path> Markdown docs for any noun/verb path.
spanish cli overview Describe the CLI surface itself.

Every command supports --json. Results go to stdout, errors/diagnostics to stderr (never mixed). Exit codes: 0 success, 1 user error, 2 environment error, 3+ reserved.

Learner state

Learner-scoped verbs take --learner <id> (default: $SPANISH_CLI_LEARNER or the OS user; the resolved id is echoed back). State persists one JSON file per learner under $SPANISH_CLI_LEARN_HOME (or $XDG_DATA_HOME/spanish_cli/learn, or ~/.local/share/spanish_cli/learn), written atomically and resumed across sessions.

Content

Stories are committed JSON files under content/stories/*.json (flat, one file per story, filename == id), each validated against the shared story schema in CI (tests/test_story_content.py). The starter set ships dev-prefixed dev stories; the full graded ladder is authored separately. The curriculum (modules, lessons, items, exercises) lives as structured data in spanish/tutor/curriculum.py.

The contract schemas + validator are cited (cite-don't-import) into spanish/contract_cite/ — see docs/contract-provenance.md.

See CLAUDE.md for the architecture and the full conventions (version-bump-every-PR, the cicd PR lane, deploy setup).

License

Apache 2.0 — see LICENSE.

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

spanish_cli-0.6.0.tar.gz (194.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

spanish_cli-0.6.0-py3-none-any.whl (96.3 kB view details)

Uploaded Python 3

File details

Details for the file spanish_cli-0.6.0.tar.gz.

File metadata

  • Download URL: spanish_cli-0.6.0.tar.gz
  • Upload date:
  • Size: 194.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.28 {"installer":{"name":"uv","version":"0.11.28","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for spanish_cli-0.6.0.tar.gz
Algorithm Hash digest
SHA256 17430a0f17c89443d0aa8bfbf3e6d23a0c364f2a8b929e9bcfae1e012b128a28
MD5 b47bc98827216f35ff09289fdc584270
BLAKE2b-256 284dd194688c616d58f58e4326cfb625acd63b6b47fcc7998865329a661b70f0

See more details on using hashes here.

File details

Details for the file spanish_cli-0.6.0-py3-none-any.whl.

File metadata

  • Download URL: spanish_cli-0.6.0-py3-none-any.whl
  • Upload date:
  • Size: 96.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.28 {"installer":{"name":"uv","version":"0.11.28","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for spanish_cli-0.6.0-py3-none-any.whl
Algorithm Hash digest
SHA256 649e3704ae67681cc852914e992b64f0402b072a678a450c701271bfa6207171
MD5 f9111b5d465bde8ea07909823b10c732
BLAKE2b-256 d580ac4fc01387ce87c42cf33853d654f1bb27b68be8dbb09f61b4a048926b33

See more details on using hashes here.

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