https://github.com/atkei/content-reviewer
An LLM-powered tool for reviewing written content
https://github.com/atkei/content-reviewer
cli document-review llm proofreading review technical-writing
Last synced: 5 months ago
JSON representation
An LLM-powered tool for reviewing written content
- Host: GitHub
- URL: https://github.com/atkei/content-reviewer
- Owner: atkei
- License: mit
- Created: 2025-12-15T23:25:53.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2025-12-31T15:38:03.000Z (6 months ago)
- Last Synced: 2026-01-13T19:43:22.766Z (5 months ago)
- Topics: cli, document-review, llm, proofreading, review, technical-writing
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/@content-reviewer/cli
- Size: 129 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Content Reviewer
An LLM-powered tool for reviewing written content. It comes with sensible defaults for technical writing (e.g., blog posts, docs, guides), and you can customize the review criteria to match your own standards.
## Features
- Sensible defaults out of the box for technical writing
- Customizable review criteria via instruction files
- Structured output with severity levels (error, warning, suggestion)
- Multiple LLM providers (OpenAI, Anthropic, Google)
## Quick Start
### CLI
```bash
export OPENAI_API_KEY="sk-..."
npx @content-reviewer/cli article.md
```
See [CLI Documentation](./packages/cli) for details.
### Library
```bash
npm install @content-reviewer/core
```
```typescript
import { ContentReviewer, createReviewConfig } from '@content-reviewer/core';
const config = createReviewConfig({
language: 'en',
llm: { provider: 'openai', apiKey: process.env.OPENAI_API_KEY },
});
const reviewer = new ContentReviewer(config);
const result = await reviewer.review({
rawContent: '# My Article\n\nContent here...',
source: 'article.md',
});
```
See [Core Documentation](./packages/core) for API reference.
## Custom Instructions
You can provide your own review criteria via an instruction file. This **replaces** the default instructions, so include everything you want checked.
```bash
content-review article.md --instruction my-standards.md
```
### Example
```markdown
## error
- ...
- Product name must be "MyProduct" (not "myproduct")
- Code blocks must specify language
## warning
- ...
- Avoid "latest version" - use exact version numbers
## ignore (do NOT report)
- Passive voice
- Paragraph length
- Minor wording suggestions
```
## Packages
| Package | Description | Version |
| ----------------------------------------- | --------------------------------- | ------------------------------------------------------------------------------------------------------------------- |
| [@content-reviewer/cli](./packages/cli) | Command-line interface | [](https://www.npmjs.com/package/@content-reviewer/cli) |
| [@content-reviewer/core](./packages/core) | Core library for programmatic use | [](https://www.npmjs.com/package/@content-reviewer/core) |
## GitHub Actions
Automate reviews in Pull Requests with [Content Reviewer Action](https://github.com/atkei/content-reviewer-action).
## Prerequisites
- Node.js >= 20.0.0
- API key for OpenAI, Anthropic, or Google
## Development
```bash
pnpm install
pnpm build
pnpm test
```
## License
MIT