create-clivly 0.7.2 → 0.7.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +20 -60
  2. package/package.json +2 -2
package/README.md CHANGED
@@ -1,10 +1,9 @@
1
1
  # create-clivly
2
2
 
3
- Scaffold Clivly into an existing app. `create-clivly` is the `create-*` entry
4
- point for `clivly init`: it runs the same initializer, with the same flags,
5
- against a version-pinned `clivly` runtime.
6
-
7
- ## Install / run
3
+ Scaffold [Clivly](https://clivly.com) — an embeddable CRM — into your existing
4
+ app. This is the `create-*` entry point for `clivly init`: it runs exactly what
5
+ `clivly init` runs, with the same flags, against a version-pinned `clivly`
6
+ runtime.
8
7
 
9
8
  ```bash
10
9
  npm create clivly
@@ -14,73 +13,34 @@ npx create-clivly
14
13
  pnpm create clivly
15
14
  ```
16
15
 
17
- Stable releases publish on npm's `latest` tag. Use `@next` only when you are
18
- deliberately validating a prerelease build.
19
-
20
- ## What it does
21
-
22
- `create-clivly` currently:
23
-
24
- - writes `clivly.config.ts`
25
- - scaffolds the supported Clivly route files for your framework
26
- - appends `.env` placeholders when they are missing
27
- - optionally runs the pairing step unless you pass `--no-login`
16
+ Clivly's stable packages publish on npm's `latest` tag. Use `@next` only when
17
+ you are intentionally validating a prerelease build.
28
18
 
29
- It does **not** mutate your existing Drizzle schema.
19
+ It writes your `clivly.config.ts`, scaffolds the CRM routes, extends your
20
+ Drizzle schema, and (unless `--no-login`) pairs this machine to your workspace.
30
21
 
31
22
  If you run it from a workspace root, it looks for a supported Drizzle app in
32
- that repo and scaffolds there. If it finds more than one candidate, it stops
33
- and shows you the directories instead of guessing.
23
+ that repo and scaffolds there. If it finds more than one, it stops and shows
24
+ you the candidate directories instead of guessing.
34
25
 
35
26
  ## Flags
36
27
 
37
- These are forwarded directly to `clivly init`:
28
+ These are forwarded straight to `clivly init`:
38
29
 
39
30
  | Flag | Effect |
40
31
  | --- | --- |
41
- | `--dry-run` | Print the plan and diff without writing files |
42
- | `--diff` | Show the full diff for each file it would write |
43
- | `--force` | Overwrite existing files and `.env` values |
44
- | `--yes` | Accept detected defaults instead of prompting |
45
- | `--schema <path\|package>` | Point at your Drizzle schema explicitly |
46
- | `--db-import <specifier>` | Set the import specifier the scaffold uses for your Drizzle client |
47
- | `--auth-import <specifier>` | Set the import specifier for your auth adapter |
32
+ | `--dry-run` | Print the plan and the diff without writing anything |
33
+ | `--force` | Overwrite existing files / `.env` values |
34
+ | `--schema <path>` | Point at your Drizzle schema explicitly |
48
35
  | `--no-login` | Skip the browser pairing step |
49
- | `--no-browser` | Print the approval URL instead of opening it |
50
-
51
- Any flag that `clivly init` accepts also works here.
36
+ | `--no-browser` | Don't auto-open the approval URL |
52
37
 
53
38
  ## Relationship to `clivly`
54
39
 
55
- - `create-clivly` is the one-time scaffolder.
56
- - `clivly` is the package you use afterwards for the runtime SDK and CLI.
57
-
58
- Example runtime imports:
59
-
60
- ```ts
61
- import { createClivlySDK } from "clivly/sdk";
62
- ```
63
-
64
- Example follow-up CLI commands:
65
-
66
- ```bash
67
- npx clivly status
68
- npx clivly dev
69
- npx clivly login
70
- ```
71
-
72
- `create-clivly` pins the `clivly` version it installs so the scaffolder and
73
- runtime stay aligned.
74
-
75
- ## More docs
76
-
77
- - Cloud onboarding guide:
78
- [Connecting to Clivly Cloud](https://github.com/amani-joseph/clivly.com/blob/master/docs/guides/connecting-to-clivly-cloud.md)
79
- - CLI reference:
80
- [packages/cli/README.md](https://github.com/amani-joseph/clivly.com/blob/master/packages/cli/README.md)
81
- - Release notes:
82
- [CHANGELOG.md](https://github.com/amani-joseph/clivly.com/blob/master/CHANGELOG.md)
40
+ - **`create-clivly`** — the scaffolder you run once to set a project up.
41
+ - **`clivly`** — the runtime you import (`import { createClivlySDK } from "clivly/sdk"`) and the CLI you run afterwards (`clivly status`, `clivly dev`, `clivly login`).
83
42
 
84
- ## License
43
+ `create-clivly` pins the `clivly` version it installs, so the scaffolder and the
44
+ runtime never drift.
85
45
 
86
- MIT
46
+ MIT licensed.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "create-clivly",
3
- "version": "0.7.2",
3
+ "version": "0.7.3",
4
4
  "private": false,
5
5
  "type": "module",
6
6
  "description": "Scaffold Clivly into your app — the create-* entry point for `clivly init`.",
@@ -34,7 +34,7 @@
34
34
  }
35
35
  },
36
36
  "dependencies": {
37
- "clivly": "0.7.2"
37
+ "clivly": "0.7.3"
38
38
  },
39
39
  "author": "Joseph Amani",
40
40
  "engines": {