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.7.0.tar.gz (196.4 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.7.0-py3-none-any.whl (97.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: spanish_cli-0.7.0.tar.gz
  • Upload date:
  • Size: 196.4 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.7.0.tar.gz
Algorithm Hash digest
SHA256 eed5502afebbd558af085c4dc5629cbf48d192d3b1c3be4600e1ed7ecfd3d711
MD5 d319bb4298155db72eedf04b111d2525
BLAKE2b-256 4fae06245d0c5d05bdc75ffa334da1f0b375966380fe4100692dfa329ac8a94e

See more details on using hashes here.

File details

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

File metadata

  • Download URL: spanish_cli-0.7.0-py3-none-any.whl
  • Upload date:
  • Size: 97.8 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.7.0-py3-none-any.whl
Algorithm Hash digest
SHA256 5442b16364b1b6f9b676cd13d91c40772ea496e633053ea3c909c21c221a17c7
MD5 74d66a94780009c16b7d9760dac1857a
BLAKE2b-256 50cd878e45e9f10575c5036d68e0c584d51a3fdd9972edc1907390544131635d

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