Clanker

Demo

Refactoring an entire codebase with natural language

Quick Start

npm install -g @ziggler/clanker
clanker

That's it. Clanker will guide you through setup on first run.

What Can It Do?

# Refactor code intelligently
> "Replace all console.log with our logger utility"
✓ Found 47 instances across 12 files
✓ Applied context-aware replacements
✓ All tests still passing

# Understand and modify complex codebases  
> "Add error handling to all async functions"
✓ Analyzed 23 async functions
✓ Added try-catch with appropriate error handling
✓ Preserved existing logic flow

# Execute multi-step workflows
> "Set up a new React component with tests"
✓ Created Button.tsx with TypeScript props
✓ Added Button.test.tsx with coverage
✓ Updated component index exports

Key Features

🧠 Intelligent File Editing

Advanced order-invariant diff algorithm for reliable file editing. Multiple edit strategies ensure changes are applied correctly even in complex scenarios. Learn more →

🛠️ Extensible Tool System

Every action is a tool. Create your own in minutes:

const prReadyTool = createTool()
  .id('pr_ready')
  .name('PR Ready Check')
  .description('Check if code is ready for PR')
  .execute(async (args, context) => {
    // Run your checks here
    const testsPass = await runTests();
    const lintPass = await checkLinting();
    const typesOk = await verifyTypes();
    
    return { 
      success: testsPass && lintPass && typesOk,
      output: 'All checks passed!'
    };
  })
  .build();

export default prReadyTool;

Tool docs →

🎨 Beautiful Terminal UI

React-powered terminal interface with:

• Syntax highlighting
• Real-time progress
• Keyboard navigation
• Confirmation dialogs

🔐 Safety First

• Confirmation prompts for destructive actions
• Dry-run mode for testing
• Full operation history
• Rollback capabilities

📦 Package Manager

Clanker includes a built-in package manager for discovering, installing, and managing tools:

Quick Start

# Search for tools
clanker --search "git"           # or -S

# Install tools
clanker --install ziggler/core   # or -I
clanker --install community/git-tools@1.2.0

# List your tools
clanker --list-installed         # or -L

# Update tools
clanker --update ziggler/core

# Uninstall tools  
clanker --uninstall community/git-tools  # or -U

Creating Your Own Tools

# Create a new tool project
npx create-clanker-tool

# Develop with hot reloading
npm run dev:watch

# Publish to the registry
npm run publish:tool

🚀 Quick Start Guide → | 📚 Full Documentation →

Tool Development Workflow

1. Create: Use create-clanker-tool to scaffold your project
2. Develop: Test locally with npm run install:local
3. Watch: Use --watch-tools for hot reloading during development
4. Publish: Submit to registry with --publish

Philosophy

Traditional AI assistants are suggestion engines. Clanker is different—it's an action engine.

Instead of:

"Here's how you could refactor this code..."

Clanker says:

"I'll refactor this code. Here's what I'm changing... Approve?"

Read our full philosophy →

Documentation

• 🚀 Getting Started - Installation and first steps
• 📦 Package Manager - Tool discovery and management
• 🔧 Tool Development - Create custom tools
• 🏗️ Architecture - How Clanker works under the hood
• 📚 API Reference - Complete API documentation

Use Cases

Contributing

We'd love your help making Clanker better!

• 🐛 Report bugs
• 💡 Request features
• 🛠️ Submit tools
• 📖 Improve docs

Community

• 💬 Discussions - Ask questions, share ideas
• 🌟 Show & Tell - Share your tools and workflows
• 🐦 Twitter - Updates and tips

License

MIT © Ziggler