@bitakit/cli 0.2.3 → 0.2.4

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 +32 -1
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -38,10 +38,41 @@ in new apps; `npx @bitakit/create-app .` creates the app in a folder that holds
38
38
  agent files, so the skill lands where an open agent session works. See the [skill README](skills/bitakit-app-development/README.md) for how to use it
39
39
  and requests to try.
40
40
 
41
+ ## Update BitaKit
42
+
43
+ Keep every `@bitakit/*` package on one release line (0.2.x, then 0.3.x). Only packages whose
44
+ shipped content changed get a patch release, so patch versions may differ within a line; `doctor`
45
+ accepts that and reports packages on different lines as an error.
46
+
47
+ Within a line, `npm update` installs the newest patches the caret ranges allow. Name the
48
+ `@bitakit/*` packages your `package.json` lists (plain `npm update` updates every dependency):
49
+
50
+ ```sh
51
+ npm update @bitakit/core @bitakit/ui @bitakit/next @bitakit/cli @bitakit/discovery
52
+ ```
53
+
54
+ `package.json` keeps its ranges; `package-lock.json` records the new versions.
55
+
56
+ A new line is outside those ranges. Install all `@bitakit/*` packages at it in one command, here
57
+ 0.3; each keeps its place in `dependencies` or `devDependencies`:
58
+
59
+ ```sh
60
+ npm install @bitakit/core@0.3 @bitakit/ui@0.3 @bitakit/next@0.3 @bitakit/cli@0.3 @bitakit/discovery@0.3
61
+ ```
62
+
63
+ Do not move one package alone (for example `npm install --save-dev @bitakit/cli@latest`): once a
64
+ new line is out, that splits the app across two lines. Follow the new line's upgrade guide when
65
+ it has one, then refresh the agent files and check the project:
66
+
67
+ ```sh
68
+ npx bitakit init --update-agent-files
69
+ npx bitakit doctor
70
+ ```
71
+
41
72
  ### Keep agent files current
42
73
 
43
74
  The installed `SKILL.md` records the CLI version and a checksum of the files as shipped in its
44
- frontmatter `metadata`. After upgrading the BitaKit packages, run:
75
+ frontmatter `metadata`. After updating the BitaKit packages, run:
45
76
 
46
77
  ```sh
47
78
  npx bitakit init --update-agent-files
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@bitakit/cli",
3
- "version": "0.2.3",
3
+ "version": "0.2.4",
4
4
  "description": "BitaKit project commands: add plugins and contributions, check a project with doctor.",
5
5
  "type": "module",
6
6
  "bin": {