@curenorway/kode-cli 1.0.0

package/README.md

@@ -0,0 +1,233 @@
+# Cure Kode CLI
+
+Command-line tool for managing JavaScript and CSS scripts for Webflow sites via Cure Kode CDN.
+
+## Installation
+
+```bash
+npm install -g @curenorway/kode-cli
+# or
+pnpm add -g @curenorway/kode-cli
+```
+
+## Quick Start
+
+```bash
+# Initialize a new project
+kode init
+
+# Pull existing scripts from remote
+kode pull
+
+# Edit your scripts locally...
+
+# Push changes
+kode push
+
+# Deploy to staging
+kode deploy
+
+# Watch for changes and auto-push
+kode watch
+```
+
+## Commands
+
+### `kode init`
+
+Initialize a Cure Kode project in the current directory.
+
+```bash
+kode init
+```
+
+This creates a `.cure-kode/config.json` file with your site configuration.
+
+### `kode pull`
+
+Download scripts from remote to your local scripts directory.
+
+```bash
+kode pull           # Pull all scripts
+kode pull --force   # Overwrite local changes
+```
+
+### `kode push`
+
+Upload local scripts to remote.
+
+```bash
+kode push                           # Push all changed scripts
+kode push my-script.js              # Push specific script
+kode push --all                     # Push all scripts
+kode push -m "Fixed bug"            # Add change message
+```
+
+### `kode watch`
+
+Watch for file changes and automatically push to remote.
+
+```bash
+kode watch                  # Watch and push
+kode watch --deploy         # Watch, push, and deploy
+kode watch --env production # Watch with specific environment
+```
+
+### `kode deploy`
+
+Deploy scripts to staging or production.
+
+```bash
+kode deploy                 # Deploy to staging (default)
+kode deploy --env production # Deploy to production
+kode deploy --promote       # Promote staging to production
+kode deploy -n "Release v2" # Deploy with notes
+```
+
+### `kode html <url>`
+
+Fetch and analyze HTML from a URL.
+
+```bash
+kode html https://mysite.com
+kode html https://mysite.com --json     # Output as JSON
+kode html https://mysite.com --scripts  # Show scripts only
+kode html https://mysite.com --styles   # Show styles only
+```
+
+### `kode status`
+
+Show current project status.
+
+```bash
+kode status
+```
+
+## Configuration
+
+### Project Config (`.cure-kode/config.json`)
+
+```json
+{
+  "siteId": "uuid",
+  "siteSlug": "my-site",
+  "siteName": "My Site",
+  "apiKey": "ck_...",
+  "scriptsDir": "kode",
+  "environment": "staging"
+}
+```
+
+### Global Config
+
+Global configuration is stored in `~/.config/cure-kode/config.json`:
+
+```json
+{
+  "apiUrl": "https://cure-app-v2-production.up.railway.app"
+}
+```
+
+### Environment Variables
+
+- `CURE_KODE_API_KEY` - API key (overrides project config)
+- `CURE_KODE_API_URL` - API URL (overrides global config)
+
+## Project Structure
+
+```
+your-project/
+├── .cure-kode/
+│   ├── config.json      # Project configuration
+│   └── scripts.json     # Script metadata (versions, sync status)
+└── kode/                # Your scripts directory
+    ├── init.js
+    ├── tracking.js
+    └── styles.css
+```
+
+## Workflow Examples
+
+### Basic Development
+
+```bash
+# 1. Initialize project
+kode init
+
+# 2. Pull existing scripts
+kode pull
+
+# 3. Start watch mode
+kode watch
+
+# 4. Edit files in your editor - they auto-push on save
+
+# 5. When ready, deploy
+kode deploy
+```
+
+### CI/CD Integration
+
+```bash
+# In your CI pipeline
+kode push --all
+kode deploy --env staging
+# Run tests...
+kode deploy --promote
+```
+
+### Team Workflow
+
+```bash
+# Developer 1: Pull latest
+kode pull --force
+
+# Developer 2: Push changes
+kode push -m "Added new animation"
+
+# Deploy to staging for review
+kode deploy -n "Review build"
+
+# After approval, promote to production
+kode deploy --promote
+```
+
+## API Key
+
+Get your API key from the Cure app:
+1. Go to https://cure-app.com/tools/kode
+2. Open your site settings
+3. Generate an API key with appropriate permissions
+
+### Permissions
+
+- `read` - Pull scripts, view status
+- `write` - Push scripts
+- `deploy` - Deploy to staging/production
+- `delete` - Delete scripts
+
+## Requirements
+
+- Node.js 18 or later
+- Cure Kode API key
+
+## Troubleshooting
+
+### "No project found"
+
+Run `kode init` to initialize a project in the current directory.
+
+### "API key invalid"
+
+Check that your API key:
+- Starts with `ck_`
+- Has not expired
+- Has the required permissions
+
+### "Script not found"
+
+The script may not exist on remote. Use `kode push` to create it.
+
+## License
+
+MIT