Skip to main content

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

Project description

french-cli

Agent + CLI that turns Claude into a private French tutor: track progress, get an overview, get advice, read stories, and learn & practice French (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 (11 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 french whoami                  # identity from culture.yaml
uv run french learn                   # self-teaching prompt (add --json)
uv run teken cli doctor . --strict    # the agent-first rubric gate CI runs

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

CLI

Verb What it does
french whoami Report this agent's nick, version, backend, and model from culture.yaml.
french learn Print a structured self-teaching prompt.
french explain <path> Markdown docs for any noun/verb path.
french overview Read-only descriptive snapshot of the agent.
french doctor Check the agent-identity invariants (prompt-file-present, backend-consistency).
french 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.

Status

The French-tutor domain is not implemented yet. The scaffold — identity, skill kit, CI, and the agent-first CLI contract — is in place, but every verb today is generic introspection (whoami, learn, explain, overview, doctor, cli overview). Progress tracking, advice, stories, and written / spoken practice are still to be built.

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

french_cli-0.4.1.tar.gz (133.3 kB view details)

Uploaded Source

Built Distribution

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

french_cli-0.4.1-py3-none-any.whl (22.4 kB view details)

Uploaded Python 3

File details

Details for the file french_cli-0.4.1.tar.gz.

File metadata

  • Download URL: french_cli-0.4.1.tar.gz
  • Upload date:
  • Size: 133.3 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 french_cli-0.4.1.tar.gz
Algorithm Hash digest
SHA256 27b9168d5543e6f488c3bc516346e8db5dbcf9b783347e806ecd57876ab0a659
MD5 d3d6d7e24a9342dce652189595071eae
BLAKE2b-256 f30937d11f71abf16412f1fbc2ee8b3942461057cf28ae4269327020eb3a150b

See more details on using hashes here.

File details

Details for the file french_cli-0.4.1-py3-none-any.whl.

File metadata

  • Download URL: french_cli-0.4.1-py3-none-any.whl
  • Upload date:
  • Size: 22.4 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 french_cli-0.4.1-py3-none-any.whl
Algorithm Hash digest
SHA256 7b38eff723be26db5578a52aa2092f827ae0316f5cb8fddab7f331b1d0a67831
MD5 44be4ca0e9ab03fd64e43c0fcbe494f9
BLAKE2b-256 473d28361082a8f712e0bbbabbdfb6ac500e5a1f4bbdfda0d9caa0a4d9a3d2e1

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