kronk-cms

KO | EN

gitlite — search

#javascript #python #hacktoberfest #typescript #llm #android #java #awesome #kubernetes #vue #pytorch #security #mcp #openai

(★ 10)

getkronk.com - the AI-First Meta CMS for Static Site Development

kronk-cms Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Kronk CLI

Build static sites faster with AI. Framework detection, quality guardrails, and seamless integration with your favorite AI coding tools.

[![npm version](https://img.shields.io/npm/v/kronk-cms.svg)](https://www.npmjs.com/package/kronk-cms)
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)

![Kronk CLI](https://getkronk.com/assets/images/kronk-screenshots/cli.png)

## What It Does

Kronk solves the problem of AI tools not understanding your static site generator. When you run `kronk init`, it:

1. Detects your framework (Hugo, Jekyll, Astro, Eleventy, etc.)
2. Generates guardrail files with framework-specific rules
3. Sets up quality checks for SEO, accessibility, performance, and security
4. Configures your project for AI-assisted development

The generated guardrails are automatically loaded by AI coding tools, ensuring every interaction follows your framework's conventions.

## Installation

```bash
npm install -g kronk-cms
```

Requires Node.js 18 or later.

## Quick Start

```bash
# Navigate to your static site project
cd my-hugo-blog

# Initialize Kronk (detects framework, generates guardrails)
kronk init

# That's it. Claude Code now understands your project.
```

## Commands

| Command | Description |
|---------|-------------|
| `kronk init` | Initialize project with framework detection and guardrails |
| `kronk new [name]` | Create a new static site project |
| `kronk detect` | Show detected framework and configuration |
| `kronk audit` | Run quality audit (SEO, accessibility, performance) |
| `kronk context` | Export project context to clipboard for AI tools |
| `kronk status` | Show project overview |
| `kronk migrate <platform>` | Migrate from WordPress to static site (`--from-wxr`, `--from-url`, `--to`, `--theme-only`) |
| `kronk theme [description]` | Generate theme with AI assistance |
| `kronk content [prompt]` | Create content with guardrails |
| `kronk addon list` | Browse available themes and plugins |
| `kronk addon install [name]` | Install a theme or plugin |
| `kronk doctor` | Check system requirements |

## Supported Frameworks

| Framework | Config Detection | Content Directory |
|-----------|-----------------|-------------------|
| Hugo | hugo.toml, config.toml | content/ |
| Jekyll | _config.yml | _posts/, _pages/ |
| Astro | astro.config.mjs | src/content/ |
| Eleventy | .eleventy.js, eleventy.config.js | configurable |
| Gatsby | gatsby-config.js | src/pages/ |
| Next.js | next.config.js | pages/, app/ |
| Nuxt | nuxt.config.js | pages/, content/ |
| Hexo | _config.yml | source/_posts/ |
| VuePress | .vuepress/config.js | docs/ |
| Docusaurus | docusaurus.config.js | docs/ |

## AI Tool Integration

Kronk works with multiple AI coding tools. Specify your preferred tool:

```bash
kronk                   # Use default AI tool
kronk --ai cursor       # Use Cursor
kronk --ai windsurf     # Use Windsurf
kronk --ai antigravity  # Use Antigravity
```

When you run `kronk init`, it generates guardrail files that AI tools automatically load. These files contain:

- Framework-specific template rules
- Content structure guidelines
- Build commands
- Quality guardrails (SEO, accessibility, performance, security)

Generate rules for specific tools:

```bash
kronk cursor rules     # Generate .cursorrules
kronk windsurf rules   # Generate windsurf rules
```

## Quality Guardrails

Guardrails are enforced through the generated `CLAUDE.md` file:

**SEO**
- Title length (50-60 characters)
- Meta description (120-160 characters)
- Semantic HTML structure
- Image alt text

**Accessibility**
- Keyboard navigation
- Color contrast (WCAG AA)
- Form labels
- ARIA attributes

**Performance**
- Image optimization
- Lazy loading
- Bundle size
- Caching headers

**Security**
- Output escaping
- HTTPS resources
- Input validation
- CSP headers

Configure guardrails in `.kronk/config.yaml`:

```yaml
guardrails:
  enforce: true
  seo: true
  accessibility: true
  performance: true
  security: true
```

## Project Structure

After running `kronk init`:

```
your-project/
├── CLAUDE.md           # Auto-generated AI guardrails
├── .kronk/
│   └── config.yaml     # Kronk configuration
├── hugo.toml           # Your framework config (example: Hugo)
└── content/            # Your content directory
```

## Configuration

The `.kronk/config.yaml` file controls Kronk behavior:

```yaml
# AI tool configuration
ai:
  default: claude-code

# Quality guardrails
guardrails:
  enforce: true
  seo: true
  accessibility: true
  performance: true
  security: true

# Project configuration
project:
  framework: auto       # auto-detect or specify
  contentDir: content/
  outputDir: public/
```

## MCP Server

Kronk includes an MCP (Model Context Protocol) server for deeper AI integration:

```bash
# Start the MCP server
kronk mcp start

# Configure in Claude Code's MCP settings
```

The MCP server provides tools for:
- Framework detection
- Content indexing
- Theme marketplace access
- Build process integration

## Examples

### Create a New Hugo Blog

```bash
kronk new my-blog --framework hugo
cd my-blog
kronk init
```

### Audit Content Quality

```bash
kronk audit
```

Output:
```
Content Audit Report

Scanned: 42 files in 3 directories

Summary:
- Errors: 2
- Warnings: 8
- Info: 15

Issues:
- content/posts/draft-post.md: Missing meta description
- content/about.md: Title too long (72 characters)
```

### Generate Theme with AI

```bash
kronk theme "minimal blog with dark mode and syntax highlighting"
```

### Export Context for AI

```bash
kronk context
# Copies rich project context to clipboard
# Paste into any AI tool for informed assistance
```

## Part of AIVory

Kronk is developed by AIVory, Inc. It integrates with other AIVory tools:

- **AIVory Guard** - Security scanning for AI-generated code
- **AIVory Architect** - Deployment and infrastructure management

Learn more at [getkronk.com](https://getkronk.com)

## Development

```bash
# Clone the repository
git clone https://github.com/aivorynet/kronk-cms.git
cd kronk-cms

# Install dependencies
npm install

# Build
npm run build

# Run locally
npm run dev

# Link for global testing
npm link
```

## License

MIT License. See [LICENSE](LICENSE) for details.

## Links

- Website: [getkronk.com](https://getkronk.com)
- Documentation: [getkronk.com/docs](https://getkronk.com/docs)
- Issues: [github.com/aivorynet/kronk-cms/issues](https://github.com/aivorynet/kronk-cms/issues)

kronk-cms

kronk-cms Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

kronk-cms

kronk-cms Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README