Skip to main content

A personal control center for grad school workflows.

Project description

Docent

PyPI version Python License GitHub stars

A personal CLI control center for grad-school workflows — papers, research, writing tools, and subprocess wrappers, all behind a single docent <tool> command.

Built with AI, Architected by a Human: Much of the codebase was written by Claude Code (Main Driver) and OpenCode Go subscription models (Kimi K2.6, DeepSeek V4 Pro, Qwen 3.5 Plus, MiniMax M2.7) (Secondary Driver), but the architecture was strictly human-directed — designed, planned, tested, and iterated over many sessions.

✨ What works today

  • docent --version, docent --help, docent list, docent info <tool>
  • Tool contract — two shapes:
    • Single-action: subclass Tool, set input_schema, override run(). CLI: docent <tool> --flag ...
    • Multi-action: decorate methods with @action(...). CLI: docent <tool> <action> --flag ...
    • A tool is one or the other — registry enforces mutual exclusivity at import time.
  • Auto-discovery — drop a file in src/docent/tools/, decorate with @register_tool, and Typer commands generate at startup from the Pydantic input schema. No CLI edits.
  • Context plumbingcontext.settings (Pydantic + ~/.docent/config.toml + env overrides), context.llm (lazy litellm wrapper), context.executor (list-args subprocess, no shell-injection surface).
  • docent.learning.RunLog — per-namespace JSONL run-log with cap-and-roll, for tools that want a "what did I do recently" history.
  • reading tool — reading queue CRUD (next / show / search / stats / remove / edit / done / start / export); Mendeley-backed ingestion; deadline notifications at startup; move-up / move-down / move-to; MCP-exposed so Claude Code can call it directly.
  • MendeleyCache — read-through file-backed cache (5-min TTL) for fresh metadata on every next / show / search. Degrades gracefully to queue snapshot on auth failure.
  • Plugin system — drop a .py file into ~/.docent/plugins/ and Docent auto-discovers it on next run.

📦 Install

# Recommended
uv tool install docent-cli

# Or pipx
pipx install docent-cli

# Or plain pip
pip install docent-cli

# Verify
docent --version

Updates:

uv tool upgrade docent-cli

🏗 Architecture

See Docent_Architecture.md for the full design. The short version:

  • Tool registry — tools self-register via @register_tool at import time. Registry stores the class, not an instance, so nothing runs until the tool is actually invoked.
  • Context object — frozen dataclass passed to every tool. Provides settings, llm (lazy litellm), and executor (subprocess wrapper).
  • UI / logic boundary — tools return typed Pydantic data. They never import docent.ui and never touch Rich. The CLI renders; the future dashboard will serialize the same data to JSON.
  • Plugin system — drop a file in ~/.docent/plugins/, decorate with @register_tool, and Typer commands generate at startup. No CLI edits needed.

📚 Tools

reading — Reading Queue

Manages your academic reading queue and syncs with Mendeley.

Workflow: Drop a PDF in your database_dir → Mendeley auto-imports it → drag it into your Docent-Queue collection → run docent reading sync-from-mendeley. Category is automatically detected from Mendeley sub-collections.

Queue management

Command Description
docent reading next Show the next paper to read (lowest order number)
docent reading next --course-name CES701 Next paper for a specific course
docent reading show <id> Show full details for one entry
docent reading search <query> Search by title, authors, notes, tags, or id
docent reading stats Counts by status, category, and course
docent reading export Export queue as JSON (default) or Markdown table
docent reading export --format markdown --status queued Filtered export, sorted by reading order

Status transitions

Command Description
docent reading start <id> Mark as currently reading (stamps started timestamp)
docent reading done <id> Mark as finished (stamps finished timestamp)
docent reading remove <id> Remove entry from queue

Editing

Command Description
docent reading edit <id> --order 1 Set reading priority (1 = read first)
docent reading set-deadline <id> --deadline 2026-06-15 Set a reading deadline
docent reading set-deadline <id> --deadline '' Clear a deadline
docent reading edit <id> --notes "Key paper for lit review" Add notes
docent reading edit <id> --tags tag1 tag2 Set tags
docent reading edit <id> --type book_chapter Set entry type (paper / book / book_chapter)
docent reading move-up <id> Move one position earlier
docent reading move-down <id> Move one position later
docent reading move-to <id> --position 3 Move to a specific position

Deadlines: Docent prints a startup warning for entries due within 3 days or overdue — once per calendar day.

Entry types: Automatically detected from Mendeley document type on sync. Override with edit --type book_chapter.

Mendeley sync

Command Description
docent reading sync-from-mendeley Pull from your Mendeley Docent-Queue collection
docent reading sync-from-mendeley --dry-run Preview changes without writing
docent reading sync-status Report queue size and PDFs in database_dir

Configuration

Command Description
docent reading config-show Show current reading settings
docent reading config-set database_dir ~/path/to/Papers Set the PDF database folder
docent reading config-set queue_collection "Docent-Queue" Set the Mendeley collection name

Other

Command Description
docent reading queue-clear --yes Wipe the entire queue (irreversible)

🔌 MCP — Use Docent from Claude Code

docent serve starts an MCP server over stdio, exposing every action as an MCP tool. Claude Code can call your reading queue directly — no terminal needed.

See docs/cli.md for the full setup guide and .mcp.json template.

🛠 Adding a tool

Single-action tools are the simplest shape:

# src/docent/tools/echo.py
from pydantic import BaseModel, Field
from docent.core import Context, Tool, register_tool


class EchoInputs(BaseModel):
    msg: str = Field(..., description="Message to echo.")
    count: int = Field(1, description="Times to repeat.")


@register_tool
class Echo(Tool):
    name = "echo"
    description = "Repeat a message N times."
    category = "demo"
    input_schema = EchoInputs

    def run(self, inputs: EchoInputs, context: Context) -> str:
        return (inputs.msg + " ") * inputs.count

Then docent echo --msg hi --count 3 just works. No CLI edits, no registration code — the decorator is enough.

For tools with several related operations on shared state, use the multi-action shape — decorate methods with @action(...). See src/docent/tools/reading.py for the reference implementation.

🧑‍💻 Development

Prerequisites

  • Python ≥ 3.11
  • uvpip install uv
  • Node.js ≥ 20 (only needed for the frontend UI)

Setup

git clone https://github.com/Kudadjie/docent.git
cd docent

# Install in editable mode (all dev deps)
uv sync --all-extras

# Make the `docent` command available globally
uv tool install --editable .

Running tests

uv run pytest          # full suite (~160 tests, ~4s)
uv run pytest -x -q    # stop on first failure, quiet output

Running the frontend

cd frontend
npm install
npm run dev            # starts at http://localhost:3000

The frontend talks to a running docent install for API calls. Make sure the editable install is active before starting the dev server.

Project layout

src/docent/
  cli.py                 # Typer app + command wiring
  core.py                # Tool base class, registry, @action decorator
  config.py              # Settings (Pydantic + TOML + env)
  mcp_server.py          # MCP stdio adapter
  bundled_plugins/
    reading/             # Reading queue tool (the reference implementation)
  tools/                 # Auto-discovered on startup
tests/                   # pytest suite
frontend/                # Next.js UI (dev only — bundled release TBD)

Updating the version

Version is declared in two places that must stay in sync:

  • pyproject.tomlversion = "x.y.z" (the published package version)
  • src/docent/__init__.py__version__ = "x.y.z" (what docent --version prints)

Update both before tagging a release.

🚀 Coming Soon

  • docent research — AI-powered research tool: paper search (alphaXiv, Google Scholar), literature review, and multi-source synthesis pipelines. Routes through Feynman as the primary research agent, with a direct Claude fallback if Feynman isn't available.

  • Web dashboard — a visual interface over the same tool registry. Browse your reading queue, run actions, and view stats from a browser — no terminal required. UI is designed with Claude and inspired by the Mintlify design system — clean aesthetics, green accents, reading-optimized layouts.

  • Omnibox (natural language interface) — type what you want in plain English and Docent routes it to the right action: "what should I read next for CES701?" or "sync my Mendeley queue" — no flags, no subcommands.

💡 Why

I have a pile of Claude Code skills I actually use (research-to-notebook, paper-pipeline, feynman wrappers, literature-review, etc.) but they only work inside a Claude session. Docent is the terminal-first home for the same workflows — scriptable, pipeable, cron-able, and eventually a dashboard. Because Docent exposes itself over MCP, every tool and plugin is also available to any MCP-capable AI agent — not just the terminal.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

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

docent_cli-1.1.0-py3-none-any.whl (53.2 kB view details)

Uploaded Python 3

File details

Details for the file docent_cli-1.1.0-py3-none-any.whl.

File metadata

  • Download URL: docent_cli-1.1.0-py3-none-any.whl
  • Upload date:
  • Size: 53.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.11 {"installer":{"name":"uv","version":"0.11.11","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 docent_cli-1.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 8c5fc295c06325d18f36619abd85308d4184f0ea57679f9f9ce6a7cf5fa68745
MD5 cf462cfb2a7b385d552e87d7136df41e
BLAKE2b-256 96abd89753f0bc9f8011b05a885e017832b5aa3e8d4c6155b7ddb8c30c5060db

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