academic-writer-setup
v0.1.0
Published
Interactive setup CLI for the Academic Writer Claude Code plugin
Readme
Academic Writer — Claude Code Plugin
AI-first academic writing assistant for Humanities researchers. Produces rigorously cited, style-matched academic articles as .docx files.
Features
- Style-matched writing — analyzes your past articles to extract your writing style, then applies it to new work
- Collaborative workflow — subject → sources → thesis proposal → outline → write → audit → publish
- Parallel processing — sections written simultaneously, each audited independently for speed
- Full workflow tracking — every pipeline step logged to Cognetivy for transparency and auditability
Installation
1. Prerequisites
You need at least one of these integrations:
| Tool | What it does | Setup | |------|-------------|-------| | Candlekeep | Cloud document library for source PDFs | https://github.com/romiluz13/candlekeep | | Cognetivy | Workflow audit trail (optional) | Built-in — no setup needed |
Choose which tools you want to use during /academic-writer-init.
2. Install the Plugin
Navigate to the folder where you do your research work, then run both commands:
cd your-research-folder
claude plugin marketplace add yodem/academic-writer
claude plugin install academic-writer --scope projectThe --scope project flag activates the plugin only in this folder, not globally.
3. Initialize Your Profile
/academic-writer-initThis is a one-time setup. You'll be asked to provide:
- Your field of study
- Citation style (Inline Parenthetical / Chicago / MLA / APA)
- 5–10 past articles for style analysis (placed in
past-articles/folder) - Which integrations to enable (Candlekeep, RAG, MongoDB, Cognetivy)
- Your research sources (if using Candlekeep)
Your profile is saved to .academic-writer/profile.json and automatically loaded each time you use the plugin.
Usage
Write an Article
/academic-writerWorkflow:
- Describe your article topic
- Select relevant sources (from Candlekeep or provide manually)
- Deep read your sources to understand coverage
- Propose thesis statements (2–3 options to choose from)
- Outline the article together (back-and-forth refinement)
- Approve the outline
- Automated: Sections written in parallel, each audited for citations
- Automated: Final synthesis for coherence and style
- Export as
.docxwith Chicago footnotes
Quick Commands
| Command | What it does |
|---------|-------------|
| /academic-writer | Write a new article |
| /academic-writer-init | First-time setup |
| /academic-writer-update-field | Change your field of study |
| /academic-writer-update-tools | Add/remove integrations (Candlekeep, RAG, etc.) |
| /academic-writer-research | Research a topic using your sources |
| /academic-writer-edit | Edit a previously written article |
| /academic-writer-edit-section | Quick edit of a single section |
| /academic-writer-health | Check all integrations & profile status |
| /academic-writer-help | Show plugin info |
File Structure
your-project/
├── past-articles/ ← Drop your published papers here (5–10 PDFs/DOCXs)
├── .academic-writer/
│ └── profile.json ← Your profile (auto-created, never edit manually)
├── .cognetivy/ ← Workflow audit trail (auto-managed)
├── articles/ ← Output .docx files go here
└── .claude-plugin/ ← Claude Code plugin cache (auto-managed)Profile Structure
Your profile (.academic-writer/profile.json) contains:
{
"fieldOfStudy": "Your field",
"citationStyle": "chicago",
"styleFingerprint": {
"sentenceLevel": { ... },
"vocabularyAndRegister": { ... },
"paragraphStructure": { ... },
"toneAndVoice": { ... },
"transitions": { ... },
"citations": { ... },
"rhetoricalPatterns": { ... },
"representativeExcerpts": [ ... ]
},
"tools": {
"candlekeep": { "enabled": true },
"mongodb-agent-skills": { "enabled": false },
"cognetivy": { "enabled": true }
},
"sources": [
{ "id": "...", "title": "...", "type": "pdf" }
]
}Update tools with /academic-writer-update-tools. Update your field with /academic-writer-update-field.
Configuration
Environment Variables (Optional)
export CANDLEKEEP_CLI=ck # Candlekeep CLI path
export COGNETIVY_CLI=cognetivy # Cognetivy CLI pathMCP Servers (Optional)
If you enable MongoDB Agent Skills, add to .mcp.json:
{
"mcpServers": {
"mongodb-agent-skills": {
"command": "node",
"args": ["/path/to/mongodb-agent-skills/dist/index.js"],
"env": {
"MONGODB_URI": "your-connection-string"
}
}
}
}Troubleshooting
"No profile found" error
Run /academic-writer-init first to set up your profile.
"Candlekeep not detected" error
Install Candlekeep CLI: https://github.com/romiluz13/candlekeep
brew tap CandleKeepAgents/candlekeep
brew install candlekeep-cli
# or
cargo install candlekeep-cliThen authenticate:
ck auth loginCitation verification fails
Ensure:
- Your sources are indexed (the init process does this automatically)
- The cited passage actually exists in your source materials
Articles won't export to .docx
Ensure python-docx is installed:
pip install python-docxArchitecture
Agents
Each agent is a specialized prompt that runs as a subagent:
- Deep Reader — Explores source material before writing to understand coverage
- Architect — Proposes thesis statements and generates article outline
- Section Writer — Writes one complete section with citations (runs in parallel)
- Auditor — Hard gate: verifies every citation against source material
- Synthesizer — Final review for coherence, transitions, and style consistency
RAG Query Modes
The plugin uses different RAG query modes for different tasks:
| Mode | Use case |
|------|----------|
| mix | General search (default) |
| bypass | Citation verification — exact quotes and page numbers |
| local | Deep dive on a specific entity |
| global | Thematic overview across all sources |
Contributing
This is a Claude Code plugin. To modify:
- Edit
.mdfiles inskills/,agents/,hooks/ - Commit and push to GitHub
- In your research folder, pull the latest:
If that fails, reinstall:claude plugin marketplace update academic-writer claude plugin update academic-writer@academic-writer --scope projectclaude plugin uninstall academic-writer --scope project claude plugin install academic-writer --scope project - Restart Claude Code to apply changes
License
MIT
Support
- Plugin issues: Open an issue on yodem/academic-writer
- Candlekeep help: https://github.com/CandleKeepAgents/candlekeep-cli
- RAG help: https://github.com/romiluz13/Agentic-Search-Vectorless
