anki-agent-toolkit 0.1.0__py3-none-any.whl

anki_agent_toolkit-0.1.0.dist-info/METADATA

@@ -0,0 +1,150 @@
+Metadata-Version: 2.4
+Name: anki-agent-toolkit
+Version: 0.1.0
+Summary: Local-first, automation-grade Anki collection management CLI
+License-Expression: AGPL-3.0-or-later
+License-File: LICENSE
+Classifier: License :: OSI Approved :: GNU Affero General Public License v3 or later (AGPLv3+)
+Requires-Python: >=3.11
+Requires-Dist: anki==25.9.2
+Requires-Dist: keyring<26,>=25
+Requires-Dist: pydantic<3,>=2.7
+Requires-Dist: typer<1,>=0.12
+Provides-Extra: dev
+Requires-Dist: pyinstaller<7,>=6.13; extra == 'dev'
+Requires-Dist: pytest<9,>=8.3; extra == 'dev'
+Requires-Dist: pyyaml<7,>=6; extra == 'dev'
+Requires-Dist: ruff<0.12,>=0.11; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# ankicli
+
+![ankicli hero](docs/images/ankicli-hero.png)
+
+Docs and product site: [takhoffman.github.io/ankicli](https://takhoffman.github.io/ankicli/)
+
+Standalone agent skills: [agent skills](https://takhoffman.github.io/ankicli/docs/agent-skills/)
+
+Goal-driven study: [learning plans](https://takhoffman.github.io/ankicli/docs/learning-plans/)
+
+`ankicli` is a local-first Anki CLI for humans who want to install and supervise a safe, scriptable
+control surface for agent harnesses like Claude, Codex, OpenClaw, and custom automation.
+
+Installed by humans. Operated by agents.
+
+Supported platforms: macOS, Windows, and Linux.
+
+License: AGPL-3.0-or-later.
+
+## Why It Exists
+
+Use `ankicli` when you want:
+
+- a terminal-native Anki control surface that agents can drive safely
+- a human-friendly install and verification path
+- profile-aware local collection access
+- explicit dry-run, confirmation, backup, and sync-preflight flows
+- stable JSON output for automation instead of fragile desktop UI scripting
+
+## Install
+
+macOS and Linux:
+
+```bash
+curl -fsSL https://raw.githubusercontent.com/Takhoffman/ankicli/main/scripts/install.sh | sh
+```
+
+Windows:
+
+```powershell
+irm https://raw.githubusercontent.com/Takhoffman/ankicli/main/scripts/install.ps1 | iex
+```
+
+Fallback package path:
+
+```bash
+pipx install ankicli
+```
+
+## Verify
+
+Run these before handing `ankicli` to an agent:
+
+```bash
+ankicli --version
+ankicli --json doctor env
+ankicli --json doctor backend
+ankicli --json profile list
+```
+
+## First Steps
+
+Inspect the local environment and confirm the target profile before real work:
+
+```bash
+ankicli --json profile default
+ankicli --json --profile "User 1" collection info
+ankicli --json --profile "User 1" search preview --kind notes --query 'deck:Default' --limit 5
+ankicli --json --profile "User 1" note add-tags --id 123 --tag review --dry-run
+```
+
+## What You Can Do
+
+- inspect profiles, collections, decks, models, tags, cards, and media
+- search and preview notes/cards before changing anything
+- mutate notes and card state with explicit dry-run and confirmation paths
+- create local backups and run explicit restore flows
+- inspect auth state and run sync preflight before real sync work
+- run local tutor-style study sessions from the terminal
+
+## Safety Defaults
+
+- Prefer `--json` for scripts and agents.
+- Use `--dry-run` first on write-capable commands.
+- Prefer `--profile` for normal local usage and `--collection` for explicit low-level targeting.
+- Use `sync status` as the safe preflight before running a real sync.
+- Sync is not backup. Use `backup create` or the built-in auto-backup flow when rollback matters.
+- Riskier local `python-anki` writes create an automatic pre-mutation backup unless you pass
+  `--no-auto-backup`.
+- Real `note delete`, `card suspend`, and `card unsuspend` require `--yes`.
+
+## Docs
+
+- Product site: [takhoffman.github.io/ankicli](https://takhoffman.github.io/ankicli/)
+- Agent skills: [agent skills](https://takhoffman.github.io/ankicli/docs/agent-skills/)
+- Learning plans: [learning plans](https://takhoffman.github.io/ankicli/docs/learning-plans/)
+- Recipes: [recipes](https://takhoffman.github.io/ankicli/docs/recipes/)
+- CLI guide: [cli guide](https://takhoffman.github.io/ankicli/docs/cli-guide/)
+- Common tasks: [common tasks](https://takhoffman.github.io/ankicli/docs/common-tasks/)
+- Quickstart: [quickstart](https://takhoffman.github.io/ankicli/docs/quickstart/)
+- Install guide: [install](https://takhoffman.github.io/ankicli/install/)
+- Profiles and collections: [profiles and collections](https://takhoffman.github.io/ankicli/docs/profiles-and-collections/)
+- Sync and backups: [sync and backups](https://takhoffman.github.io/ankicli/docs/sync-and-backups/)
+- Study mode: [study](https://takhoffman.github.io/ankicli/docs/study/)
+- Troubleshooting: [troubleshooting](https://takhoffman.github.io/ankicli/docs/troubleshooting/)
+
+Every major docs page is designed to be readable by humans and easy to copy into an LLM chat.
+
+## License
+
+`ankicli` is licensed under `AGPL-3.0-or-later`. It depends on the upstream Anki runtime, which is
+also AGPL-licensed. See [LICENSE](/Users/thoffman/ankicli/LICENSE).
+
+## For Contributors And Advanced Backend Work
+
+The top-level README is intentionally product-oriented. Contributor and backend-contract detail still
+exists, but it lives in deeper docs and repo files:
+
+- CLI and backend contract: [`docs/spec.md`](/Users/thoffman/ankicli/docs/spec.md)
+- Release/install workflows: [product site](https://takhoffman.github.io/ankicli/)
+- Source and workflows: [repository](https://github.com/Takhoffman/ankicli)
+
+Common contributor commands:
+
+```bash
+uv sync --extra dev --frozen
+PYTEST_PLUGINS=ankicli.pytest_plugin uv run pytest -c pyproject.toml -m "unit or smoke" --proof-report /tmp/ankicli-proof-report.json
+uv run ruff check .
+uv build
+uv run pytest -m distribution
+```

anki_agent_toolkit-0.1.0.dist-info/RECORD

@@ -0,0 +1,23 @@
+ankicli/__init__.py,sha256=MBuf1Qb991QenBBPRwZTc1ivQHU5MJm0pn5SWQ2cxCA,74
+ankicli/main.py,sha256=XYHN3Z9SdJ57OuhFauVC6OFK0Vx6KnZ4VcGo6fLmJcg,51880
+ankicli/pytest_plugin.py,sha256=28UAf6_X9r4sGLSSzxSCiA8T7Spwc85qX4T_TeReaXk,3388
+ankicli/runtime.py,sha256=jThMLZnIaqOCmbTQwQVj3ml3MWaES3imFQToTimmwLs,4579
+ankicli/app/catalog.py,sha256=RKjCqJvb7EGdbyGU8hjB67kN1_mM7PvONBY8Wdn2-sg,43980
+ankicli/app/credentials.py,sha256=RDpITdgEb0-Fw3BIVuC7I9_fnfhCxN7Dww69bT1pDno,12565
+ankicli/app/errors.py,sha256=9MtzJ8xyh-BiksyRvDvm9IWIlptmLYkaaH3pevGh6FM,3237
+ankicli/app/ios_audio_migration.py,sha256=ROsGWuKn38kUKSnZyOQF06T1J8iagEh_w3Rfx69DG8w,22527
+ankicli/app/models.py,sha256=2_ZRifwEP8v1QlN0jSq5VgrtDpwgR0lEJOY-4DPadLM,1284
+ankicli/app/output.py,sha256=9_CBq_zbHJh8m3Sjv4R8Kki6lIZdGDYtcQOKn8zIa6Q,1172
+ankicli/app/profiles.py,sha256=dR_TDI_rrA9mLT_KI3b1jic142JWzmHh453Ms8AuGHs,5640
+ankicli/app/quality_matrix.py,sha256=Ik0_WWxaKtcwvDt6AhrkIBQ7uf85jLlJVGSrn61Cqs8,30887
+ankicli/app/releases.py,sha256=oeTlxacauy3nNmhnzW_5UWTu7gr1g1hqCsAq4Oq3Ulk,1456
+ankicli/app/services.py,sha256=sDwaSw2Io3IRUleVX9C_qf3df8R1kn-SvcxPZn0wgo0,63400
+ankicli/app/study.py,sha256=tKx3n5NIM2zt6z7jY21G78S628JOiv8V5su2EzWhNuQ,52529
+ankicli/backends/ankiconnect.py,sha256=Xk0oTApJ7iXJ5UHPWX5r3chUpW4ipDFYPbEpUbDzCY4,21650
+ankicli/backends/base.py,sha256=SCYsvqupQZoNu4kEHOIyosqjDg5jMZ0t5VmwhhK-lyo,7935
+ankicli/backends/python_anki.py,sha256=Ap9WtyyKbxH1QTjmXCoZ4xwNhBy0FpbVc0DdR6WKrgY,63090
+anki_agent_toolkit-0.1.0.dist-info/METADATA,sha256=hrS4sB0_3KQMis8A5zcdVZ0M7K2El5oBW_lMgq2hyXE,5564
+anki_agent_toolkit-0.1.0.dist-info/WHEEL,sha256=QccIxa26bgl1E6uMy58deGWi-0aeIkkangHcxk2kWfw,87
+anki_agent_toolkit-0.1.0.dist-info/entry_points.txt,sha256=rS5WVyPO6uT9TmvEGUaSLst8hXi9CLgwNXZcekrPIjQ,45
+anki_agent_toolkit-0.1.0.dist-info/licenses/LICENSE,sha256=W3CLvDwrYdpWB2Gj7TCtfewPryux4v2K7ZYkvF3f4Ak,573
+anki_agent_toolkit-0.1.0.dist-info/RECORD,,

anki_agent_toolkit-0.1.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.29.0
+Root-Is-Purelib: true
+Tag: py3-none-any

anki_agent_toolkit-0.1.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+ankicli = ankicli.main:run

anki_agent_toolkit-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,17 @@
+GNU AFFERO GENERAL PUBLIC LICENSE
+Version 3, 19 November 2007
+
+SPDX-License-Identifier: AGPL-3.0-or-later
+
+Copyright (C) 2026 ankicli contributors
+
+This repository is licensed under the GNU Affero General Public License,
+version 3 or, at your option, any later version.
+
+`ankicli` depends on and distributes the upstream Anki runtime, which is
+licensed under the GNU Affero General Public License, version 3 or later.
+
+You should have received a copy of the GNU Affero General Public License
+along with this program. If not, see:
+
+https://www.gnu.org/licenses/agpl-3.0.txt

ankicli/__init__.py

@@ -0,0 +1,6 @@
+"""ankicli package."""
+
+__all__ = ["__version__"]
+
+__version__ = "0.1.0"
+