@schemic/cli 0.1.0-alpha.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Vertio Solutions
+
+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,67 @@
+# @schemic/cli
+
+The command-line interface for [Schemic](https://github.com/schemichq/schemic) —
+`schemic` (with the short alias `sc`) generates and runs schema migrations against
+any database. It's **dialect-agnostic**: the CLI loads your database driver from
+`schemic.config.ts`, so the same commands work whatever you're targeting.
+
+## Install
+
+Install the CLI alongside a driver:
+
+```bash
+bun add @schemic/cli @schemic/surrealdb   # or @schemic/postgres, …
+```
+
+The CLI is dialect-neutral; the driver provides the authoring types and the DDL.
+See each driver's README for its exact peer deps and quickstart —
+[`@schemic/surrealdb`](../surrealdb#readme), [`@schemic/postgres`](../postgres#readme).
+
+## Quick start
+
+```bash
+sc init                      # scaffold a project (default driver: surrealdb)
+sc init --driver postgres    # …or scaffold for a specific driver
+```
+
+`init` writes a `schemic.config.ts`, a sample schema, a seed stub, and
+`.env.example`. From there:
+
+```bash
+sc gen add_users    # write a migration from your schema changes
+sc migrate          # apply pending migrations
+sc status           # show applied vs pending
+```
+
+## Commands
+
+| Command | What it does |
+| --- | --- |
+| `init [--driver <name>]` | Scaffold a project — config, schema, seed, `.env.example` (default driver: `surrealdb`). |
+| `gen [name]` | Write a migration from the schema diff. |
+| `migrate [count]` | Apply pending migrations — all, the next N, or `--to <tag>` (alias: `up`). |
+| `rollback [count]` | Revert applied migrations, newest first (alias: `down`). |
+| `status` | Show applied vs pending migrations (`--json` for machine output). |
+| `diff` | Preview pending changes without writing a migration (`--live` to compare against the database). |
+| `push` | Apply the schema directly — no migration files (alias: `sync`). |
+| `pull` | Introspect a live database back into your schema files. |
+| `new <kind> <name>` | Scaffold a blank, hand-written migration. |
+| `check` | Replay migrations in a throwaway engine to confirm they reproduce the schema. |
+| `seed` | Run the project's seed script against a connection. |
+| `doctor` | Print the resolved config and test the connection. |
+| `snapshot reset` | Clear the migration snapshot. |
+| `unlock` | Release a stale migration lock. |
+
+Run `sc <command> --help` for flags. Support for some commands varies by driver
+(e.g. `pull` and `diff --ts` are SurrealDB today) — see your driver's
+`docs/COVERAGE.md`.
+
+## Docs
+
+Full guides, concepts, and reference live at
+[schemic.dev](https://schemic.dev). This package is part of the
+[Schemic](https://github.com/schemichq/schemic) toolkit.
+
+## License
+
+[MIT](./LICENSE) © Vertio Solutions