Skip to content

Commit 9abb7a1

Browse files
author
committed
Deployed 63caac5 with MkDocs version: 1.6.1
1 parent 99b1262 commit 9abb7a1

4 files changed

Lines changed: 229 additions & 16 deletions

File tree

‎cli-reference.html‎

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1118,21 +1118,26 @@ <h2 id="studyctl">studyctl<a class="headerlink" href="#studyctl" title="Permanen
11181118
studyctl<span class="w"> </span>struggles<span class="w"> </span>--days<span class="w"> </span><span class="m">30</span><span class="w"> </span><span class="c1"># Find recurring struggle topics</span>
11191119
studyctl<span class="w"> </span>wins<span class="w"> </span>--days<span class="w"> </span><span class="m">30</span><span class="w"> </span><span class="c1"># Show your learning wins</span>
11201120
studyctl<span class="w"> </span>progress<span class="w"> </span>CONCEPT<span class="w"> </span>-t<span class="w"> </span>TOPIC<span class="w"> </span>-c<span class="w"> </span>LEVEL<span class="w"> </span><span class="c1"># Record progress on a concept</span>
1121+
studyctl<span class="w"> </span>progress-map<span class="w"> </span><span class="c1"># Visual map of all tracked concepts</span>
1122+
studyctl<span class="w"> </span>resume<span class="w"> </span><span class="c1"># Where you left off (auto-context)</span>
1123+
studyctl<span class="w"> </span>streaks<span class="w"> </span><span class="c1"># Study streak and consistency stats</span>
1124+
studyctl<span class="w"> </span>teachback<span class="w"> </span>CONCEPT<span class="w"> </span>-t<span class="w"> </span>TOPIC<span class="w"> </span>-s<span class="w"> </span>SCORES<span class="w"> </span>--type<span class="w"> </span>TYPE<span class="w"> </span><span class="c1"># Record teach-back score</span>
1125+
studyctl<span class="w"> </span>teachback-history<span class="w"> </span>CONCEPT<span class="w"> </span><span class="c1"># Show teach-back score progression</span>
1126+
studyctl<span class="w"> </span>bridge<span class="w"> </span>add<span class="w"> </span>SRC<span class="w"> </span>TGT<span class="w"> </span>-s<span class="w"> </span>DOMAIN<span class="w"> </span>-t<span class="w"> </span>DOMAIN<span class="w"> </span><span class="c1"># Add a knowledge bridge</span>
1127+
studyctl<span class="w"> </span>bridge<span class="w"> </span>list<span class="w"> </span><span class="c1"># List knowledge bridges</span>
11211128
studyctl<span class="w"> </span>schedule-blocks<span class="w"> </span>--start<span class="w"> </span><span class="m">14</span>:00<span class="w"> </span><span class="c1"># Generate .ics calendar study blocks</span>
11221129
studyctl<span class="w"> </span>topics<span class="w"> </span><span class="c1"># List configured topics</span>
11231130
studyctl<span class="w"> </span>audio<span class="w"> </span>TOPIC<span class="w"> </span><span class="c1"># Generate NotebookLM audio overview</span>
11241131
studyctl<span class="w"> </span>dedup<span class="w"> </span><span class="o">[</span>TOPIC<span class="o">]</span><span class="w"> </span>--all<span class="w"> </span>--dry-run<span class="w"> </span><span class="c1"># Remove duplicate notebook sources</span>
1125-
studyctl<span class="w"> </span>resume<span class="w"> </span><span class="c1"># Where you left off (auto-context)</span>
1126-
studyctl<span class="w"> </span>streaks<span class="w"> </span><span class="c1"># Study streak and consistency stats</span>
1127-
studyctl<span class="w"> </span>progress-map<span class="w"> </span><span class="c1"># Visual map of all tracked concepts</span>
11281132
studyctl<span class="w"> </span>state<span class="w"> </span>push<span class="p">|</span>pull<span class="p">|</span>status<span class="p">|</span>init<span class="w"> </span><span class="c1"># Cross-machine state sync</span>
11291133
studyctl<span class="w"> </span>schedule<span class="w"> </span>install<span class="p">|</span>remove<span class="p">|</span>list<span class="p">|</span>add<span class="p">|</span>delete<span class="w"> </span><span class="c1"># Manage scheduled jobs</span>
11301134
studyctl<span class="w"> </span>config<span class="w"> </span>init<span class="w"> </span><span class="c1"># Interactive setup wizard</span>
11311135
studyctl<span class="w"> </span>config<span class="w"> </span>show<span class="w"> </span><span class="c1"># Display current configuration</span>
1136+
studyctl<span class="w"> </span>web<span class="w"> </span><span class="o">[</span>--port<span class="w"> </span>PORT<span class="o">]</span><span class="w"> </span><span class="o">[</span>--host<span class="w"> </span>HOST<span class="o">]</span><span class="w"> </span><span class="c1"># Launch study web app</span>
1137+
studyctl<span class="w"> </span>tui<span class="w"> </span><span class="c1"># Launch interactive TUI dashboard</span>
11321138
studyctl<span class="w"> </span>docs<span class="w"> </span>serve<span class="w"> </span><span class="o">[</span>--port<span class="w"> </span>PORT<span class="o">]</span><span class="w"> </span><span class="c1"># Serve docs site locally</span>
11331139
studyctl<span class="w"> </span>docs<span class="w"> </span>open<span class="w"> </span><span class="c1"># Build and open docs in browser</span>
11341140
studyctl<span class="w"> </span>docs<span class="w"> </span>list<span class="w"> </span><span class="c1"># List available doc pages</span>
1135-
studyctl<span class="w"> </span>tui<span class="w"> </span><span class="c1"># Launch interactive TUI dashboard</span>
11361141
studyctl<span class="w"> </span>docs<span class="w"> </span><span class="nb">read</span><span class="w"> </span>PAGE<span class="w"> </span><span class="c1"># Read a page aloud via study-speak</span>
11371142
</code></pre></div>
11381143
<h3 id="health-updates">Health &amp; Updates<a class="headerlink" href="#health-updates" title="Permanent link">&para;</a></h3>

‎roadmap.html‎

Lines changed: 218 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -810,10 +810,10 @@
810810
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
811811

812812
<li class="md-nav__item">
813-
<a href="#v10-foundation-current" class="md-nav__link">
813+
<a href="#v10-foundation" class="md-nav__link">
814814
<span class="md-ellipsis">
815815

816-
v1.0 — Foundation (current)
816+
v1.0 — Foundation
817817

818818
</span>
819819
</a>
@@ -1079,6 +1079,89 @@
10791079
</span>
10801080
</a>
10811081

1082+
</li>
1083+
1084+
<li class="md-nav__item">
1085+
<a href="#v20-unified-platform" class="md-nav__link">
1086+
<span class="md-ellipsis">
1087+
1088+
v2.0 — Unified Platform
1089+
1090+
</span>
1091+
</a>
1092+
1093+
</li>
1094+
1095+
<li class="md-nav__item">
1096+
<a href="#v21-health-self-update-current" class="md-nav__link">
1097+
<span class="md-ellipsis">
1098+
1099+
v2.1 — Health &amp; Self-Update (current)
1100+
1101+
</span>
1102+
</a>
1103+
1104+
</li>
1105+
1106+
<li class="md-nav__item">
1107+
<a href="#next" class="md-nav__link">
1108+
<span class="md-ellipsis">
1109+
1110+
Next
1111+
1112+
</span>
1113+
</a>
1114+
1115+
<nav class="md-nav" aria-label="Next">
1116+
<ul class="md-nav__list">
1117+
1118+
<li class="md-nav__item">
1119+
<a href="#phase-6-cicd-pipeline" class="md-nav__link">
1120+
<span class="md-ellipsis">
1121+
1122+
Phase 6: CI/CD Pipeline
1123+
1124+
</span>
1125+
</a>
1126+
1127+
</li>
1128+
1129+
<li class="md-nav__item">
1130+
<a href="#phase-7-docker-web-server-side-tts" class="md-nav__link">
1131+
<span class="md-ellipsis">
1132+
1133+
Phase 7: Docker Web + Server-Side TTS
1134+
1135+
</span>
1136+
</a>
1137+
1138+
</li>
1139+
1140+
<li class="md-nav__item">
1141+
<a href="#phase-2-fastapi-web-ui" class="md-nav__link">
1142+
<span class="md-ellipsis">
1143+
1144+
Phase 2: FastAPI Web UI
1145+
1146+
</span>
1147+
</a>
1148+
1149+
</li>
1150+
1151+
<li class="md-nav__item">
1152+
<a href="#phase-3-mcp-agent-integration" class="md-nav__link">
1153+
<span class="md-ellipsis">
1154+
1155+
Phase 3: MCP Agent Integration
1156+
1157+
</span>
1158+
</a>
1159+
1160+
</li>
1161+
1162+
</ul>
1163+
</nav>
1164+
10821165
</li>
10831166

10841167
</ul>
@@ -1143,10 +1226,10 @@
11431226
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
11441227

11451228
<li class="md-nav__item">
1146-
<a href="#v10-foundation-current" class="md-nav__link">
1229+
<a href="#v10-foundation" class="md-nav__link">
11471230
<span class="md-ellipsis">
11481231

1149-
v1.0 — Foundation (current)
1232+
v1.0 — Foundation
11501233

11511234
</span>
11521235
</a>
@@ -1412,6 +1495,89 @@
14121495
</span>
14131496
</a>
14141497

1498+
</li>
1499+
1500+
<li class="md-nav__item">
1501+
<a href="#v20-unified-platform" class="md-nav__link">
1502+
<span class="md-ellipsis">
1503+
1504+
v2.0 — Unified Platform
1505+
1506+
</span>
1507+
</a>
1508+
1509+
</li>
1510+
1511+
<li class="md-nav__item">
1512+
<a href="#v21-health-self-update-current" class="md-nav__link">
1513+
<span class="md-ellipsis">
1514+
1515+
v2.1 — Health &amp; Self-Update (current)
1516+
1517+
</span>
1518+
</a>
1519+
1520+
</li>
1521+
1522+
<li class="md-nav__item">
1523+
<a href="#next" class="md-nav__link">
1524+
<span class="md-ellipsis">
1525+
1526+
Next
1527+
1528+
</span>
1529+
</a>
1530+
1531+
<nav class="md-nav" aria-label="Next">
1532+
<ul class="md-nav__list">
1533+
1534+
<li class="md-nav__item">
1535+
<a href="#phase-6-cicd-pipeline" class="md-nav__link">
1536+
<span class="md-ellipsis">
1537+
1538+
Phase 6: CI/CD Pipeline
1539+
1540+
</span>
1541+
</a>
1542+
1543+
</li>
1544+
1545+
<li class="md-nav__item">
1546+
<a href="#phase-7-docker-web-server-side-tts" class="md-nav__link">
1547+
<span class="md-ellipsis">
1548+
1549+
Phase 7: Docker Web + Server-Side TTS
1550+
1551+
</span>
1552+
</a>
1553+
1554+
</li>
1555+
1556+
<li class="md-nav__item">
1557+
<a href="#phase-2-fastapi-web-ui" class="md-nav__link">
1558+
<span class="md-ellipsis">
1559+
1560+
Phase 2: FastAPI Web UI
1561+
1562+
</span>
1563+
</a>
1564+
1565+
</li>
1566+
1567+
<li class="md-nav__item">
1568+
<a href="#phase-3-mcp-agent-integration" class="md-nav__link">
1569+
<span class="md-ellipsis">
1570+
1571+
Phase 3: MCP Agent Integration
1572+
1573+
</span>
1574+
</a>
1575+
1576+
</li>
1577+
1578+
</ul>
1579+
</nav>
1580+
14151581
</li>
14161582

14171583
</ul>
@@ -1432,7 +1598,7 @@
14321598

14331599

14341600
<h1 id="roadmap">Roadmap<a class="headerlink" href="#roadmap" title="Permanent link">&para;</a></h1>
1435-
<h2 id="v10-foundation-current">v1.0 — Foundation (current)<a class="headerlink" href="#v10-foundation-current" title="Permanent link">&para;</a></h2>
1601+
<h2 id="v10-foundation">v1.0 — Foundation<a class="headerlink" href="#v10-foundation" title="Permanent link">&para;</a></h2>
14361602
<ul>
14371603
<li>[x] Monorepo with studyctl + agent-session-tools</li>
14381604
<li>[x] Kiro CLI + Claude Code agent definitions</li>
@@ -1527,19 +1693,19 @@ <h4 id="cowork-integration-claude-desktop">Cowork Integration (Claude Desktop)<a
15271693
</ul>
15281694
<h2 id="v12-community-polish">v1.2 — Community &amp; Polish<a class="headerlink" href="#v12-community-polish" title="Permanent link">&para;</a></h2>
15291695
<ul>
1530-
<li>[ ] PyPI publishing</li>
1696+
<li>[x] PyPI publishing (v2.0 — OIDC trusted publishing)</li>
15311697
<li>[ ] Additional test coverage (exporters, scheduler, CLI commands, speak, PDF)</li>
15321698
<li>[ ] VSCode integration (fix circular import)</li>
1533-
<li>[ ] TUI interface (textual)</li>
1699+
<li>[x] TUI interface (textual) (v1.5)</li>
15341700
<li>[ ] Watchdog file watcher for auto-sync</li>
15351701
<li>[ ] Community-contributed study topics</li>
15361702
<li>[ ] Localisation support</li>
15371703
<li>[x] TTS voice output (kokoro-tts / ltts integration)</li>
15381704
<li>[x] MkDocs documentation site (font toggle, Nord colours, reading preferences, 7 admonition types, <code>studyctl docs</code> CLI)</li>
15391705
<li>[x] Gemini CLI / OpenCode / Amp agents (unified shared framework)</li>
1540-
<li>[ ] CI Python version matrix (3.12, 3.13)</li>
1541-
<li>[ ] GitHub Pages deployment workflow</li>
1542-
<li>[ ] CHANGELOG.md and release automation</li>
1706+
<li>[x] CI Python version matrix (3.12, 3.13)</li>
1707+
<li>[x] GitHub Pages deployment workflow</li>
1708+
<li>[x] CHANGELOG.md and release automation (git-cliff + release.yml)</li>
15431709
<li>[ ] <code>query_sessions.py</code> refactor — split into CLI, formatters, resolver modules</li>
15441710
</ul>
15451711
<h2 id="v13-audhd-intelligence-from-review">v1.3 — AuDHD Intelligence (from review)<a class="headerlink" href="#v13-audhd-intelligence-from-review" title="Permanent link">&para;</a></h2>
@@ -1611,6 +1777,48 @@ <h2 id="v15-code-quality-framework-unification">v1.5 — Code Quality &amp; Fram
16111777
<li>[x] <strong>Docs site</strong>: <code>studyctl docs serve/open/list/read</code> commands</li>
16121778
<li>[x] <strong>Agent installation integration</strong>: <code>install-agents.sh</code> called from <code>config init</code> flow</li>
16131779
</ul>
1780+
<h2 id="v20-unified-platform">v2.0 — Unified Platform<a class="headerlink" href="#v20-unified-platform" title="Permanent link">&para;</a></h2>
1781+
<p>Monorepo restructure, content pipeline absorption, packaging, and infrastructure hardening.</p>
1782+
<ul>
1783+
<li>[x] <strong>Phase 0</strong>: Config consolidation (<code>settings.py</code> single source), CLI split into <code>cli/</code> package with LazyGroup (12 modules), WAL mode on all SQLite connections, service layer (<code>services/review.py</code>, <code>services/content.py</code>), JSON contract formalised</li>
1784+
<li>[x] <strong>Phase 1</strong>: Content absorption — 7 modules from pdf-by-chapters (<code>splitter</code>, <code>notebooklm_client</code>, <code>syllabus</code>, <code>markdown_converter</code>, <code>models</code>, <code>storage</code>), 10 CLI commands under <code>studyctl content</code>, 76 tests</li>
1785+
<li>[x] <strong>Phase 4</strong>: PyPI publishing (<code>studyctl</code> on PyPI), Homebrew personal tap (<code>NetDevAutomate/studyctl/studyctl</code>), OIDC trusted publishing, <code>studyctl setup</code> wizard</li>
1786+
<li>[x] <strong>327 tests</strong>, 4 skipped (optional deps)</li>
1787+
</ul>
1788+
<h2 id="v21-health-self-update-current">v2.1 — Health &amp; Self-Update (current)<a class="headerlink" href="#v21-health-self-update-current" title="Permanent link">&para;</a></h2>
1789+
<p>Diagnostic engine, self-update mechanism, and AI-guided setup for non-technical users.</p>
1790+
<ul>
1791+
<li>[x] <strong><code>studyctl doctor</code></strong> — 19 health checks across 7 categories (core, database, config, agents, deps, voice, updates). Rich table output, <code>--json</code> for AI agents/CI, <code>--quiet</code> for scripts, <code>--category</code> for filtering. Exit codes: 0=healthy, 1=actionable, 2=core failure.</li>
1792+
<li>[x] <strong><code>studyctl update</code></strong> — check for available updates (always exit 0, informational)</li>
1793+
<li>[x] <strong><code>studyctl upgrade</code></strong> — apply updates with <code>--dry-run</code>, <code>--component</code>, <code>--force</code>. Package manager detection (uv/brew/pip), DB backup with 30-day pruning, agent definition updates.</li>
1794+
<li>[x] <strong>Install-mentor agent</strong> — tool-agnostic AI-guided setup prompt (<code>agents/shared/install-mentor.md</code>). Uses <code>studyctl doctor --json</code> as contract, fix loop capped at 3 iterations. Works with Claude Code, Kiro, Gemini CLI, OpenCode, Amp.</li>
1795+
<li>[x] <strong>Agent manifest</strong> — <code>agents/manifest.json</code> tracks SHA-256 hashes of all agent definitions. <code>scripts/update-agent-manifest.py</code> regenerates.</li>
1796+
<li>[x] <strong>Documentation</strong> — README, CLI reference, setup guide, agent-install all updated for non-technical users.</li>
1797+
</ul>
1798+
<h2 id="next">Next<a class="headerlink" href="#next" title="Permanent link">&para;</a></h2>
1799+
<h3 id="phase-6-cicd-pipeline">Phase 6: CI/CD Pipeline<a class="headerlink" href="#phase-6-cicd-pipeline" title="Permanent link">&para;</a></h3>
1800+
<p>Nightly drift detection, pre-release gate, and Docker image pipeline. Spec at <code>docs/ci-cd-pipeline.md</code>.</p>
1801+
<ul>
1802+
<li>[ ] Nightly: fresh install on Ubuntu + macOS, <code>studyctl doctor --json</code> as gate</li>
1803+
<li>[ ] Pre-release: upgrade path N-1 -&gt; N, triggered on release tags</li>
1804+
<li>[ ] Docker: <code>studyctl-web</code> image with server-side TTS, health check via doctor</li>
1805+
<li>[ ] <code>compatibility.json</code> for pre-flight version checks</li>
1806+
</ul>
1807+
<h3 id="phase-7-docker-web-server-side-tts">Phase 7: Docker Web + Server-Side TTS<a class="headerlink" href="#phase-7-docker-web-server-side-tts" title="Permanent link">&para;</a></h3>
1808+
<ul>
1809+
<li>[ ] Docker image running <code>studyctl web</code> with kokoro-onnx TTS</li>
1810+
<li>[ ] FastAPI audio endpoint for browser playback</li>
1811+
</ul>
1812+
<h3 id="phase-2-fastapi-web-ui">Phase 2: FastAPI Web UI<a class="headerlink" href="#phase-2-fastapi-web-ui" title="Permanent link">&para;</a></h3>
1813+
<ul>
1814+
<li>[ ] Replace stdlib HTTP server with FastAPI</li>
1815+
<li>[ ] HTMX + Alpine.js frontend, artefact viewer, progress dashboard</li>
1816+
</ul>
1817+
<h3 id="phase-3-mcp-agent-integration">Phase 3: MCP Agent Integration<a class="headerlink" href="#phase-3-mcp-agent-integration" title="Permanent link">&para;</a></h3>
1818+
<ul>
1819+
<li>[ ] FastMCP v1 server with stdio transport</li>
1820+
<li>[ ] Flashcard/quiz generation tools, study context, onboarding agent</li>
1821+
</ul>
16141822

16151823

16161824

‎search/search_index.js‎

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎search/search_index.json‎

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

0 commit comments

Comments
 (0)