@openlor/dotai 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 gobylor
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,127 @@
+# dotai
+
+AI CLI config manager — sync Claude Code, Codex, and more between machines.
+
+## What is this?
+
+`dotai` is a dotfiles manager for the AI coding era. It syncs your AI CLI configurations (settings, permissions, skills, commands, plugins) between machines via a JSON manifest backed by Git.
+
+**Two dimensions, one tool:**
+- **Horizontal:** manage configs for Claude Code + Codex (+ future CLIs) on one machine
+- **Vertical:** sync all configs between machines
+
+## Quick Start
+
+```bash
+# In your config repo directory:
+npx dotai init          # Auto-discover CLIs, generate manifest
+npx dotai export        # Copy configs from machine to repo
+git add -A && git commit -m "my ai config"
+git push
+
+# On another machine:
+npx dotai use <your-github-user>/dotai-config
+```
+
+## Commands
+
+| Command | Description |
+|---------|-------------|
+| `dotai init` | Auto-discover AI CLIs, generate `dotai.json` manifest + `.gitignore` |
+| `dotai export` | Copy configs from machine to repo, auto-generate README |
+| `dotai import` | Copy configs from repo to machine (with backup) |
+| `dotai diff` | Show differences between repo and machine |
+| `dotai status` | Sync summary dashboard |
+| `dotai use <user/repo>` | Import config from a GitHub repo |
+| `dotai doctor` | Health check: validate manifest, scan for credentials, flag stale paths |
+
+### Common Flags
+
+| Flag | Available on | Description |
+|------|-------------|-------------|
+| `--only <tool>` | export, import, diff, status | Operate on a single tool only |
+| `--dry-run` | import, use | Preview changes without writing |
+| `--sync` | import | Delete machine files not in repo (with backup) |
+| `--verbose` | export, import, use | Show per-file operations |
+
+## How It Works
+
+### 1. Manifest (`dotai.json`)
+
+A JSON file declares which files from each CLI's config directory should be synced:
+
+```json
+{
+  "version": 1,
+  "tools": {
+    "claude": {
+      "source": "~/.claude",
+      "include": ["settings.json", "commands/", "skills/"],
+      "exclude": ["sessions/", "cache/", "history.jsonl"]
+    },
+    "codex": {
+      "source": "~/.codex",
+      "include": ["config.toml", "rules/", "skills/"],
+      "exclude": ["history.jsonl", "sessions/", "auth.json"]
+    }
+  }
+}
+```
+
+### 2. Tool Profiles
+
+Built-in profiles for Claude Code and Codex know which files are portable (settings, commands, skills) and which are ephemeral (sessions, cache, history). `dotai init` uses these profiles to auto-generate the manifest.
+
+Adding support for a new AI CLI is as simple as adding a JSON profile file.
+
+### 3. File State Model
+
+Every managed file is in one of four states:
+
+| State | Meaning |
+|-------|---------|
+| `in-sync` | Identical in repo and on machine |
+| `modified` | Exists in both but content differs |
+| `repo-only` | In repo but not on machine |
+| `machine-only` | On machine but not in repo |
+
+### 4. Security
+
+- **No transformation** — files are copied exactly as-is
+- `dotai doctor` scans for credential files accidentally in repo
+- `dotai use` restricts source paths to known AI CLI config directories
+- Auto-generated `.gitignore` excludes credentials and ephemeral data
+
+## Design Principles
+
+- **No transformation** — JSON stays JSON, TOML stays TOML. No path rewriting.
+- **Additive by default** — `import` only copies, never deletes (unless `--sync`)
+- **Backup before overwrite** — every import creates a timestamped backup per tool
+- **Two-repo model** — this repo is the tool; your configs live in a separate repo
+
+## Supported CLIs
+
+| CLI | Config Dir | Status |
+|-----|-----------|--------|
+| Claude Code | `~/.claude` | Built-in |
+| Codex | `~/.codex` | Built-in |
+| Cursor | `~/.cursor` | Add profile |
+| Windsurf | `~/.windsurf` | Add profile |
+| Aider | `~/.aider` | Add profile |
+
+## Installation
+
+```bash
+# Use without installing (recommended)
+npx dotai <command>
+
+# Or install globally
+npm install -g dotai
+bun install -g dotai
+```
+
+Requires Node.js >= 18 or Bun.
+
+## License
+
+MIT