kintone-migrator 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Hikaru Otabe
+
+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,120 @@
+# kintone-migrator
+
+A CLI tool for migrating kintone form schemas.
+
+Compares a YAML-defined schema file against an actual kintone app form, providing diff detection, migration, schema capture, and more.
+
+## Installation
+
+```bash
+npm install -g kintone-migrator
+```
+
+Requires Node.js 22 or later.
+
+## Configuration
+
+Connection details for kintone can be specified via CLI arguments or environment variables. CLI arguments take precedence.
+
+| CLI Argument | Environment Variable | Description |
+|---------|----------|------|
+| `--domain`, `-d` | `KINTONE_DOMAIN` | kintone domain (e.g., `example.cybozu.com`) |
+| `--username`, `-u` | `KINTONE_USERNAME` | kintone username |
+| `--password`, `-p` | `KINTONE_PASSWORD` | kintone password |
+| `--app-id`, `-a` | `KINTONE_APP_ID` | kintone app ID |
+| `--schema-file`, `-f` | `SCHEMA_FILE_PATH` | Schema file path (default: `schema.yaml`) |
+
+### .env File
+
+Environment variables can also be defined in a `.env` file and loaded with `dotenv-cli` or similar tools.
+
+```env
+KINTONE_DOMAIN=example.cybozu.com
+KINTONE_USERNAME=your_username
+KINTONE_PASSWORD=your_password
+KINTONE_APP_ID=123
+SCHEMA_FILE_PATH=schema.yaml
+```
+
+## Commands
+
+### `diff`
+
+Detects differences between the schema file and the current kintone form.
+
+```bash
+kintone-migrator diff
+kintone-migrator diff -d example.cybozu.com -a 123
+```
+
+### `migrate`
+
+Applies schema file changes to the kintone form. Displays the diff and prompts for confirmation before execution.
+
+```bash
+kintone-migrator migrate
+```
+
+### `override`
+
+Overwrites the entire kintone form with the schema file contents. Fields not defined in the schema will be deleted.
+
+```bash
+kintone-migrator override
+```
+
+### `capture`
+
+Saves the current kintone form schema to a file.
+
+```bash
+kintone-migrator capture
+kintone-migrator capture -f my-schema.yaml
+```
+
+### `dump`
+
+Dumps kintone form field definitions and layout in JSON format. For debugging purposes.
+
+```bash
+kintone-migrator dump
+```
+
+`fields.json` and `layout.json` will be output to the current directory.
+
+## Schema File
+
+Schema files define the desired kintone form configuration in YAML format. The `layout` key at the root describes form rows, groups, subtables, and field definitions.
+
+```yaml
+layout:
+  - type: ROW
+    fields:
+      - code: customer_name
+        type: SINGLE_LINE_TEXT
+        label: 顧客名
+        size: { width: "200" }
+        required: true
+        unique: true
+  - type: GROUP
+    code: detail_group
+    label: 詳細情報
+    openGroup: true
+    layout:
+      - type: ROW
+        fields:
+          - code: note
+            type: MULTI_LINE_TEXT
+            label: 備考
+            size: { width: "400" }
+```
+
+For the full specification and all supported field types, see:
+
+- [Schema Specification](./spec/schema.md) — format reference for all field types, layout items, decoration elements, and validation rules
+- [Sample Schema (YAML)](./spec/sample_schema.yaml) — comprehensive example covering all field types
+- [Sample Schema (JSON)](./spec/sample_schema.json) — equivalent example in JSON format
+
+## License
+
+MIT