cosmux
v0.4.3
Published
AI coding assistant widget for local development - powered by Claude
Maintainers
zelgerjReadme
Cosmux
AI coding assistant widget for local development - powered by Claude.
Installation
npm install -D cosmuxVite
// vite.config.ts
import { defineConfig } from 'vite'
import react from '@vitejs/plugin-react'
import { cosmux } from 'cosmux/vite'
export default defineConfig({
plugins: [
react(),
cosmux()
]
})Add your API key to .env:
ANTHROPIC_API_KEY=sk-ant-...Run npm run dev - the widget appears in the bottom-right corner.
Next.js
// next.config.mjs
import { withCosmux } from 'cosmux/next'
export default withCosmux({
// your existing config
})For App Router, create a widget component:
// components/CosmuxWidget.tsx
'use client'
import { useEffect } from 'react'
export function CosmuxWidget({ port = 3333 }: { port?: number }) {
useEffect(() => {
if (process.env.NODE_ENV !== 'development') return
;(window as any).__COSMUX_CONFIG__ = { serverUrl: `http://localhost:${port}` }
const script = document.createElement('script')
script.src = `http://localhost:${port}/static/inject.js`
script.async = true
document.body.appendChild(script)
return () => { script.remove() }
}, [port])
return null
}Then add to your layout:
// app/layout.tsx
import { CosmuxWidget } from '@/components/CosmuxWidget'
export default function RootLayout({ children }) {
return (
<html>
<body>
{children}
<CosmuxWidget />
</body>
</html>
)
}Configuration
Vite Plugin
cosmux({
port: 3333, // Server port (default: 3333)
autoStart: true, // Auto-start server (default: true)
injectWidget: true, // Inject widget script (default: true)
workspace: './', // Workspace path (default: cwd)
})Next.js
withCosmux(nextConfig, {
port: 3333,
autoStart: true,
workspace: './',
})CLI
npx cosmux serve
npx cosmux serve --port 4000Requirements
- Node.js 18+
- Anthropic API key (or Claude Max subscription)
How it works
npm installdownloads a platform-specific binary- The plugin starts the Cosmux server automatically
- A widget script is injected into your HTML
- Press
Cmd+K(or click the button) to open the assistant
Uninstall
npm uninstall cosmuxLicense
MIT